BUSBOY::MetadataField Class Reference

A single primitive value. More...

#include <MetadataField.h>

Inheritance diagram for BUSBOY::MetadataField:

Public Member Functions
	MetadataField ()
	MetadataField (const MetadataField &field)
bool	getBooleanValue () const
char	getByteValue () const
int	getIntegerValue () const
float	getFloatValue () const
double	getDoubleValue () const
long double	getLongDoubleValue () const
std::string	getStringValue () const
size_t	getSize_tValue () const
Primitive::Type	getPrimitiveType () const
MetadataElement::Type	getMetadataElementType () const
virtual CloneableMetadataElement *	clone () const
MetadataField &	operator= (const MetadataField &field)
bool	operator== (const MetadataField &field) const
bool	operator== (const MetadataElement &element) const
bool	operator!= (const MetadataField &field) const
bool	operator!= (const MetadataElement &element) const
std::string	str ()
	Returns a formatted representation of the field, including value and type. More...
	~MetadataField ()
std::string	toString () const

Static Public Member Functions
static MetadataField	createBoolean (const bool val)
static MetadataField	createInteger (const int val)
static MetadataField	createByte (const char val)
static MetadataField	createFloat (const float val)
static MetadataField	createDouble (const double val)
static MetadataField	createLongDouble (const long double val)
static MetadataField	createString (const char *val)
static MetadataField	createString (const std::string &val)
static MetadataField	createSize_t (const size_t val)
static MetadataField	parseField (const std::string &str, Primitive::Type type)
static const MetadataField *	castToField (const MetadataElement *element)
static MetadataField *	castToField (MetadataElement *element)
static const MetadataField &	castToField (const MetadataElement &element)
static MetadataField &	castToField (MetadataElement &element)

Additional Inherited Members
Public Types inherited from BUSBOY::MetadataElement
enum	Type {   FIELD, ARRAY, LIST, MAP,   KEY }
Static Protected Member Functions inherited from BUSBOY::MetadataElement
template<typename T >
static const T *	castElement (const MetadataElement *element, Type type)
template<typename T >
static T *	castElement (MetadataElement *element, Type type)
template<typename T >
static const T &	castElement (const MetadataElement &element, Type type)
template<typename T >
static T &	castElement (MetadataElement &element, Type type)

Detailed Description

A single primitive value.

This class is immutable. Use is as follows:

• call createXXX(val) to create a new field
• call getXXXValue() to recover the primitive value
• call toString() to get the string representation of the primitive value
• call parseField(str,type) to recover the field from the string representation

Constructor & Destructor Documentation

BUSBOY::MetadataField::MetadataField

(

)

BUSBOY::MetadataField::MetadataField

(

const MetadataField &

field

)

BUSBOY::MetadataField::~MetadataField

(

)

Member Function Documentation

const MetadataField * BUSBOY::MetadataField::castToField ( const MetadataElement *  element )

static

MetadataField * BUSBOY::MetadataField::castToField ( MetadataElement *  element )

static

const MetadataField & BUSBOY::MetadataField::castToField ( const MetadataElement &  element )

static

MetadataField & BUSBOY::MetadataField::castToField ( MetadataElement &  element )

static

CloneableMetadataElement * BUSBOY::MetadataField::clone ( ) const

virtual

Implements BUSBOY::CloneableMetadataElement.

MetadataField BUSBOY::MetadataField::createBoolean ( const bool  val )

static

MetadataField BUSBOY::MetadataField::createByte ( const char  val )

static

MetadataField BUSBOY::MetadataField::createDouble ( const double  val )

static

MetadataField BUSBOY::MetadataField::createFloat ( const float  val )

static

MetadataField BUSBOY::MetadataField::createInteger ( const int  val )

static

MetadataField BUSBOY::MetadataField::createLongDouble ( const long double  val )

static

MetadataField BUSBOY::MetadataField::createSize_t ( const size_t  val )

static

MetadataField BUSBOY::MetadataField::createString ( const char *  val )

static

MetadataField BUSBOY::MetadataField::createString ( const std::string &  val )

static

bool BUSBOY::MetadataField::getBooleanValue

(

)

const

char BUSBOY::MetadataField::getByteValue

(

)

const

double BUSBOY::MetadataField::getDoubleValue

(

)

const

float BUSBOY::MetadataField::getFloatValue

(

)

const

int BUSBOY::MetadataField::getIntegerValue

(

)

const

long double BUSBOY::MetadataField::getLongDoubleValue

(

)

const

MetadataElement::Type BUSBOY::MetadataField::getMetadataElementType ( ) const

virtual

Implements BUSBOY::MetadataElement.

Primitive::Type BUSBOY::MetadataField::getPrimitiveType

(

)

const

size_t BUSBOY::MetadataField::getSize_tValue

(

)

const

std::string BUSBOY::MetadataField::getStringValue

(

)

const

bool BUSBOY::MetadataField::operator!=

(

const MetadataField &

field

)

const

bool BUSBOY::MetadataField::operator!= ( const MetadataElement &  element ) const

virtual

Implements BUSBOY::MetadataElement.

MetadataField & BUSBOY::MetadataField::operator=

(

const MetadataField &

field

)

bool BUSBOY::MetadataField::operator==

(

const MetadataField &

field

)

const

bool BUSBOY::MetadataField::operator== ( const MetadataElement &  element ) const

virtual

Implements BUSBOY::MetadataElement.

MetadataField BUSBOY::MetadataField::parseField ( const std::string &  str, Primitive::Type  type  )

static

std::string BUSBOY::MetadataField::str

(

)

Returns a formatted representation of the field, including value and type.

std::string BUSBOY::MetadataField::toString

(

)

const

---

The documentation for this class was generated from the following files:

• src/cpp/api/metadata/MetadataField.h
• src/cpp/impl/metadata/MetadataField.cpp