Celartem::DjVu::PropertySet

Celartem::DjVu::PropertySet Class Reference

#include <djv_propset.h>

Inheritance diagram for Celartem::DjVu::PropertySet:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual size_t getSize () const =0
virtual bool isEmpty () const =0
virtual void clear ()=0
virtual bool contains (const String &inKey) const =0
virtual String get (const String &inKey) const =0
virtual void set (const String &inKey, const String &inValue)=0
virtual void remove (const String &inKey)=0
virtual AutoPtr
< PropertySetIterator > 		enumProperties () const =0
virtual AutoPtr< PropertySet > duplicate () const =0
virtual void encode (Stream *inStream) const =0
virtual void decode (Stream *inStream)=0
virtual void merge (const PropertySet *inPropSet)=0
virtual bool isIdenticalTo (const PropertySet *inPropSet) const =0

Static Public Member Functions

static AutoPtr< PropertySet > create ()
static AutoPtr< PropertySet > create (Stream *inStream)

Detailed Description

This class defines an interface for property-value pair container.

Definition at line 65 of file djv_propset.h.

Member Function Documentation

virtual size_t Celartem::DjVu::PropertySet::getSize (  )  const [pure virtual]

Get the number of properties.

Returns:
The number of properties in this instance.

virtual bool Celartem::DjVu::PropertySet::isEmpty (  )  const [pure virtual]

Determine whether this PropertySet is empty or not.

Returns:
true if empty, otherwise false.

virtual void Celartem::DjVu::PropertySet::clear (  )  [pure virtual]

Remove all the entries from the container.

virtual bool Celartem::DjVu::PropertySet::contains ( const String &  inKey  )  const [pure virtual]

Determine whether this PropertySet contains propery of the sepcifeid key.

Parameters:
inKey A key.
Returns:
true if it exists, otherwise false.

virtual String Celartem::DjVu::PropertySet::get ( const String &  inKey  )  const [pure virtual]

Get a property value associated to the specified key.

Parameters:
inKey A key of a property.
Returns:
The value if the key exists; otherwise returns NullString.

virtual void Celartem::DjVu::PropertySet::set ( const String &  inKey,
const String &  inValue 
) [pure virtual]

Set a value to the specified key.

Parameters:
inKey A key of a property.
Returns:
The value to set.

virtual void Celartem::DjVu::PropertySet::remove ( const String &  inKey  )  [pure virtual]

Remove a property by key. If the key does not exist, the function does nothing.

Parameters:
inKey A key of a property.

virtual AutoPtr<PropertySetIterator> Celartem::DjVu::PropertySet::enumProperties (  )  const [pure virtual]

Enumerate all the properties.

Returns:
Pointer to a newly created PropertySetIterator instance.

virtual AutoPtr<PropertySet> Celartem::DjVu::PropertySet::duplicate (  )  const [pure virtual]

Create a copy of the instance.

Returns:
Pointer to the newly created PropertySet instance.

virtual void Celartem::DjVu::PropertySet::encode ( Stream *  inStream  )  const [pure virtual]

Serialize the instance to the specified Stream.

Parameters:
inStream Pointer to a Stream instance.

virtual void Celartem::DjVu::PropertySet::decode ( Stream *  inStream  )  [pure virtual]

Deserialize the instance from the specified Stream instance.

Parameters:
inStream Pointer to a Stream instance.

virtual void Celartem::DjVu::PropertySet::merge ( const PropertySet *  inPropSet  )  [pure virtual]

Merges the specified instance to this instance.

Parameters:
inPropSet Pointer to an instance to merge.

virtual bool Celartem::DjVu::PropertySet::isIdenticalTo ( const PropertySet *  inPropSet  )  const [pure virtual]

Determines whether this instance is identical to the specified instance or not.

Parameters:
inPropSet Pointer to an instance to compare with.

static AutoPtr<PropertySet> Celartem::DjVu::PropertySet::create (  )  [static]

Create an empty PropertySet instance using the default implementation.

Returns:
Pointer to the newly created instance.

static AutoPtr<PropertySet> Celartem::DjVu::PropertySet::create ( Stream *  inStream  )  [static]

Create a PropertySet instance by decoding the specified Stream.

Parameters:
inStream Pointer to a Stream instance.
Returns:
Pointer to the newly created instance.

The documentation for this class was generated from the following file:
This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:23:29 2008.