os/ossrv/lowlevellibsandfws/pluginfw/Framework/ResolverTest/ResolverStateAccessor.h
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Framework/ResolverTest/ResolverStateAccessor.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,163 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// The definition of the accessor class for the CResolver tests.
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __RESOLVERSTATEACCESSOR_H__
1.22 +#define __RESOLVERSTATEACCESSOR_H__
1.23 +
1.24 +#include <s32file.h>
1.25 +
1.26 +// ______________________________________________________________________________
1.27 +//
1.28 +/**
1.29 + @internalComponent
1.30 +
1.31 + Comments : State accessor for the CDefaultResolver object under test.
1.32 + */
1.33 +class TDefaultResolver_StateAccessor : public MStateAccessor
1.34 + {
1.35 +public:
1.36 + /**
1.37 + @fn InvariantTest(TAny* aTestObject)
1.38 + Intended Usage : Checks if CDefaultResolver has violated its invariants.
1.39 + @since 7.0
1.40 + @param TAny* A pointer to the object under test.
1.41 + @return TInt KErrNone if the invariants were valid, error code otherwise.
1.42 + @pre TDefaultResolver_StateAccessor is fully constructed.
1.43 + @post The class under test is set to the state specified.
1.44 + */
1.45 + inline TInt InvariantTest(TAny* aTestObject);
1.46 +
1.47 + /**
1.48 + @fn Internalize(TAny* aTestObject)
1.49 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.50 + @since 7.0
1.51 + @param aTestObject The object to be tested
1.52 + @return KErrNone if the internalize was successful.
1.53 + @return One of the EPOC standard error codes indicating the reason
1.54 + for the failure to load the object state.
1.55 + @pre TDefaultResolver_StateAccessor is fully constructed, and
1.56 + valid test object must be passed in.
1.57 + @post The class under test is set to the state specified
1.58 + */
1.59 + inline virtual TInt Internalize(TAny* aTestObject);
1.60 +
1.61 + /**
1.62 + @fn Externalize(TAny* aTestObject)
1.63 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.64 + @since 7.0
1.65 + @param aTestObject The object to be tested
1.66 + @return KErrNone if the internalize was successful.
1.67 + @return One of the EPOC standard error codes indicating the reason
1.68 + for the failure to externalize the object.
1.69 + @pre TDefaultResolver_StateAccessor is fully constructed, and
1.70 + valid test object must be passed in.
1.71 + @post Returns an error code dependant on the result of the test
1.72 + */
1.73 + inline virtual TInt Externalize(TAny* aTestObject);
1.74 +
1.75 + /**
1.76 + @fn InternalizeL(RFileReadStream& aStream, CDefaultResolver* aDefaultResolver)
1.77 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.78 + Error Condition : Leaves with an error code.
1.79 + @since 7.0
1.80 + @param aStream The filestream to read from .
1.81 + @param aDefaultResolver A pointer to the CDefaultResolver object under test.
1.82 + @return None.
1.83 + @pre TDefaultResolver_StateAccessor is fully constructed.
1.84 + @post The class under test is set to the state specified.
1.85 + */
1.86 + inline void InternalizeL(RFileReadStream& aStream, CDefaultResolver* aDefaultResolver);
1.87 +
1.88 + /**
1.89 + @fn ExternalizeL(RFileWriteStream& aStream, CDefaultResolver* aDefaultResolver)
1.90 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.91 + Error Condition : Leaves with an error code.
1.92 + @since 7.0
1.93 + @param aStream The filestream to persist into.
1.94 + @param aDefaultResolver A pointer to the CDefaultResolver object under test.
1.95 + @return None.
1.96 + @pre TDefaultResolver_StateAccessor is fully constructed.
1.97 + @post No change to the class under test, its internal state.
1.98 + is persisted.
1.99 + */
1.100 + inline void ExternalizeL(RFileWriteStream& aStream, CDefaultResolver* aDefaultResolver);
1.101 +
1.102 +/**
1.103 + @fn TBool CDefaultResolver::Match(const TDesC8& aImplementationType,
1.104 + const TDesC8& aMatchType,
1.105 + TBool aUseWildcards) const
1.106 + Intended Usage :
1.107 + Error Condition :
1.108 + @since 7.0
1.109 + @param aImplementationType " "
1.110 + @param aMatchType " "
1.111 + @param aUseWildcards " "
1.112 + @return TBool ETrue if a match has been found
1.113 + @pre The object is fully constructed
1.114 + */
1.115 + TBool Match(CDefaultResolver& aResolver,
1.116 + const TDesC8& aImplementationType,
1.117 + const TDesC8& aMatchType,
1.118 + TBool aUseWildcards) const;
1.119 +
1.120 +/**
1.121 + @fn Resolve(CDefaultResolver& aResolver,
1.122 + RImplInfoArray& aImplementationData,
1.123 + const TEComResolverParams& aAdditionalParameters) const
1.124 + Intended Usage :
1.125 + Error Condition :
1.126 + @since 7.0
1.127 + @param aResolver " "
1.128 + @param aImplementationData " "
1.129 + @param aAdditionalParameters " "
1.130 + @return The Uid of a suitable implementation
1.131 + @pre The object is fully constructed
1.132 + */
1.133 + TUid Resolve(CDefaultResolver& aResolver,
1.134 + RImplInfoArray& aImplementationData,
1.135 + const TEComResolverParams& aAdditionalParameters) const;
1.136 +
1.137 +private:
1.138 + /**
1.139 + @fn InternalizeL(CDefaultResolver* aDefaultResolver)
1.140 + Intended Usage : Implemented by the developer to set the state of the object under test.
1.141 + Error Condition : Leaves with an error code.
1.142 + @since 7.0
1.143 + @param TAny* A pointer to the object under test.
1.144 + @return None.
1.145 + @pre TDefaultResolver_StateAccessor is fully constructed.
1.146 + @post The class under test is set to the state specified.
1.147 + */
1.148 + inline void InternalizeL(CDefaultResolver* aDefaultResolver);
1.149 +
1.150 + /**
1.151 + @fn ExternalizeL(CDefaultResolver* aDefaultResolver)
1.152 + Intended Usage : Implemented by the developer to persist the state of the object under test.
1.153 + Error Condition : Leaves with an error code.
1.154 + @since 7.0
1.155 + @param TAny* A pointer to the object under test.
1.156 + @return None.
1.157 + @pre TDefaultResolver_StateAccessor is fully constructed.
1.158 + @post No change to the class under test, its internal state.
1.159 + is persisted.
1.160 + */
1.161 + inline void ExternalizeL(CDefaultResolver* aDefaultResolver);
1.162 + }; // TDefaultResolver_StateAccessor
1.163 +
1.164 +#include "ResolverStateAccessor.inl"
1.165 +
1.166 +#endif // __RESOLVERSTATEACCESSOR_H__