Oracle Coherence for C++ API


PortableProperty Class Reference

#include <coherence/io/pof/annotation/PortableProperty.hpp>

Inherits Object, and Annotation.

List of all members.

Detailed Description

A PortableProperty marks a method accessor as a POF serialized attribute.

Whilst the PortableProperty::getIndex() and PortableProperty::getCodec() can be explicitly specified they can be determined by classes that use this annotation. Hence these attributes serve as hints to the underlying parser.

hr 2011.06.29

Public Types

typedef spec::Handle Handle
 PortableProperty Handle definition.
typedef spec::View View
 PortableProperty View definition.
typedef spec::Holder Holder
 PortableProperty Holder definition.

Public Member Functions

virtual Class::View annotationType () const
 Return the annotation type of this annotation.
virtual int32_t getIndex () const
 The index of this property.
virtual Class::View getCodec () const
 A codec to use to short-circuit determining the type via the method return type.

Static Public Member Functions

static Class::View getStaticClass ()
 A convenience static method to return a reference to the Class definition for this PortableProperty annotation class.

Member Function Documentation

virtual int32_t getIndex (  )  const [virtual]

The index of this property.

See also:
POF index

virtual Class::View getCodec (  )  const [virtual]

A codec to use to short-circuit determining the type via the method return type.

This could be used to determine concrete implementations of interfaces, i.e. when the method return is a Map this type definition could instruct the code to utilize a LinkedHashMap.

class representing the codec to use for this property

The documentation for this class was generated from the following file:
Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.