Passwordfile library  3.1.3
C++ library to read/write passwords from/to encrypted files
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Io::Field Class Reference

The Field class holds field information which consists of a name and a value and is able to serialize and deserialize this information. More...

#include <field.h>

Collaboration diagram for Io::Field:
[legend]

Public Member Functions

 Field (AccountEntry *tiedAccount, const std::string &name=std::string(), const std::string &value=std::string())
 Constructs a new account entry for the specified account with the specified name and value. More...
 
 Field (AccountEntry *tiedAccount, std::istream &stream)
 Constructs a new account entry for the specified account which is deserialize from the specified stream. More...
 
bool isEmpty () const
 Returns an indication whether the entry is empty. More...
 
const std::string & name () const
 Returns the name. More...
 
void setName (const std::string &name)
 Sets the name. More...
 
const std::string & value () const
 Returns the value. More...
 
void setValue (const std::string &value)
 Sets the value. More...
 
FieldType type () const
 Returns the type. More...
 
void setType (FieldType type)
 Sets the type. More...
 
AccountEntrytiedAccount () const
 Returns the tied account. More...
 
void make (std::ostream &stream) const
 Serializes the current instance to the specified stream. More...
 

Static Public Member Functions

static bool isValidType (int number)
 Returns whether the specified number is a valid field type. More...
 

Protected Attributes

std::string m_extendedData
 

Detailed Description

The Field class holds field information which consists of a name and a value and is able to serialize and deserialize this information.

Definition at line 19 of file field.h.

Constructor & Destructor Documentation

§ Field() [1/2]

Io::Field::Field ( AccountEntry tiedAccount,
const std::string &  name = std::string(),
const std::string &  value = std::string() 
)

Constructs a new account entry for the specified account with the specified name and value.

Definition at line 23 of file field.cpp.

§ Field() [2/2]

Io::Field::Field ( AccountEntry tiedAccount,
std::istream &  stream 
)

Constructs a new account entry for the specified account which is deserialize from the specified stream.

Exceptions
ThrowsParsingException when an parsing error occurs.

Definition at line 35 of file field.cpp.

Member Function Documentation

§ isEmpty()

bool Io::Field::isEmpty ( ) const
inline

Returns an indication whether the entry is empty.

Definition at line 50 of file field.h.

§ isValidType()

bool Io::Field::isValidType ( int  number)
inlinestatic

Returns whether the specified number is a valid field type.

Definition at line 114 of file field.h.

§ make()

void Io::Field::make ( std::ostream &  stream) const

Serializes the current instance to the specified stream.

Definition at line 62 of file field.cpp.

§ name()

const std::string & Io::Field::name ( ) const
inline

Returns the name.

Definition at line 58 of file field.h.

§ setName()

void Io::Field::setName ( const std::string &  name)
inline

Sets the name.

Definition at line 66 of file field.h.

§ setType()

void Io::Field::setType ( FieldType  type)
inline

Sets the type.

Definition at line 98 of file field.h.

§ setValue()

void Io::Field::setValue ( const std::string &  value)
inline

Sets the value.

Definition at line 82 of file field.h.

§ tiedAccount()

AccountEntry * Io::Field::tiedAccount ( ) const
inline

Returns the tied account.

Definition at line 106 of file field.h.

§ type()

FieldType Io::Field::type ( ) const
inline

Returns the type.

Definition at line 90 of file field.h.

§ value()

const std::string & Io::Field::value ( ) const
inline

Returns the value.

Definition at line 74 of file field.h.

Member Data Documentation

§ m_extendedData

std::string Io::Field::m_extendedData
protected

Definition at line 43 of file field.h.


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