Interface IPofContext
The IPofContext interface represents a set of user types that can be serialized to and deserialized from a POF stream.
Namespace: Tangosol.IO.Pof
Assembly: Coherence.dll
Syntax
public interface IPofContext : ISerializerMethods
GetPofSerializer(int)
Return an IPofSerializer that can be used to serialize and deserialize an object of the specified user type to and from a POF stream.
Declaration
IPofSerializer GetPofSerializer(int typeId)Parameters
| Type | Name | Description |
|---|---|---|
| int | typeId | The type identifier of the user type that can be serialized and deserialized using the returned IPofSerializer; must be non-negative. |
Returns
| Type | Description |
|---|---|
| IPofSerializer | An IPofSerializer for the specified user type. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If the specified user type is negative or unknown to this IPofContext. |
GetType(int)
Determine the type associated with the given user type identifier.
Declaration
Type GetType(int typeId)Parameters
| Type | Name | Description |
|---|---|---|
| int | typeId | The user type identifier; must be non-negative. |
Returns
| Type | Description |
|---|---|
| Type | The type associated with the specified user type identifier. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If the specified user type is negative or unknown to this IPofContext. |
GetTypeName(int)
Determine the name of the type associated with a user type identifier.
Declaration
string GetTypeName(int typeId)Parameters
| Type | Name | Description |
|---|---|---|
| int | typeId | The user type identifier; must be non-negative. |
Returns
| Type | Description |
|---|---|
| string | The name of the type associated with the specified user type identifier. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If the specified user type is negative or unknown to this IPofContext. |
GetUserTypeIdentifier(object)
Determine the user type identifier associated with the given object.
Declaration
int GetUserTypeIdentifier(object o)Parameters
| Type | Name | Description |
|---|---|---|
| object | o | An instance of a user type; must not be |
Returns
| Type | Description |
|---|---|
| int | The type identifier of the user type associated with the given object. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If the user type associated with the given object is unknown to this IPofContext. |
GetUserTypeIdentifier(string)
Determine the user type identifier associated with the given type name.
Declaration
int GetUserTypeIdentifier(string typeName)Parameters
| Type | Name | Description |
|---|---|---|
| string | typeName | The name of a user type; must not be |
Returns
| Type | Description |
|---|---|
| int | The type identifier of the user type associated with the given type name. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If the user type associated with the given type name is unknown to this IPofContext. |
GetUserTypeIdentifier(Type)
Determine the user type identifier associated with the given type.
Declaration
int GetUserTypeIdentifier(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| Type | type | A user type; must not be |
Returns
| Type | Description |
|---|---|
| int | The type identifier of the user type associated with the given type. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | If the user type associated with the given type is unknown to this IPofContext. |
IsUserType(object)
Determine if the given object is of a user type known to this IPofContext.
Declaration
bool IsUserType(object o)Parameters
| Type | Name | Description |
|---|---|---|
| object | o | The object to test; must not be |
Returns
| Type | Description |
|---|---|
| bool | true iff the specified object is of a valid user type. |
IsUserType(string)
Determine if the type with the given name is a user type known to this IPofContext.
Declaration
bool IsUserType(string typeName)Parameters
| Type | Name | Description |
|---|---|---|
| string | typeName | The name of the type to test; must not be |
Returns
| Type | Description |
|---|---|
| bool | true iff the type with the specified name is a valid user type. |
IsUserType(Type)
Determine if the given type is a user type known to this IPofContext.
Declaration
bool IsUserType(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| Type | type | The type to test; must not be |
Returns
| Type | Description |
|---|---|
| bool | true iff the specified type is a valid user type. |