#include <berryXMLMemento.h>

Inheritance diagram for berry::XMLMemento:

Collaboration diagram for berry::XMLMemento:

Public Types
typedef std::ostream	XMLByteOutputStream

typedef std::istream	XMLByteInputStream

Public Types inherited from berry::Object
typedef Object	Self

typedef berry::SmartPointer< Self >	Pointer

typedef berry::SmartPointer< const Self >	ConstPointer

typedef berry::WeakPointer< Self >	WeakPtr

typedef berry::WeakPointer< const Self >	ConstWeakPtr

Public Member Functions
	berryObjectMacro (XMLMemento)

	XMLMemento (Poco::XML::Document document, Poco::XML::Element elem)

	~XMLMemento () override

IMemento::Pointer	CopyChild (IMemento::Pointer child)

IMemento::Pointer	CreateChild (const QString &type) override

IMemento::Pointer	CreateChild (const QString &type, const QString &id) override

IMemento::Pointer	GetChild (const QString &type) const override

QList< IMemento::Pointer >	GetChildren (const QString &type) const override

QString	GetType () const override

QString	GetID () const override

bool	GetInteger (const QString &key, int &value) const override

bool	GetFloat (const QString &key, double &value) const override

bool	GetString (const QString &key, QString &value) const override

bool	GetBoolean (const QString &key, bool &value) const override

QString	GetTextData () const override

QList< QString >	GetAttributeKeys () const override

void	PutFloat (const QString &key, double value) override

void	PutInteger (const QString &key, int value) override

void	PutMemento (IMemento::Pointer memento) override

void	PutString (const QString &key, const QString &value) override

void	PutBoolean (const QString &key, bool value) override

void	PutTextData (const QString &data) override

void	Save (XMLByteOutputStream &writer)

virtual Poco::XML::Element *	GetElement () const

Public Member Functions inherited from berry::IMemento
	berryObjectMacro (berry::IMemento)

	~IMemento () override

Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const

virtual Reflection::TypeInfo	GetTypeInfo () const

virtual QList< Reflection::TypeInfo >	GetSuperclasses () const

virtual void	Delete ()

QDebug	Print (QDebug os, Indent Indent=0) const

virtual QString	ToString () const

virtual uint	HashCode () const

virtual bool	operator< (const Object *) const

void	Register () const

void	UnRegister (bool del=true) const

int	GetReferenceCount () const

void	SetReferenceCount (int)

void	AddDestroyListener (const MessageAbstractDelegate<> &delegate) const

void	RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const

virtual bool	operator== (const Object *) const

Static Public Member Functions
static XMLMemento::Pointer	CreateReadRoot (berry::XMLMemento::XMLByteInputStream &reader)

static XMLMemento::Pointer	CreateReadRoot (berry::XMLMemento::XMLByteInputStream &reader, const QString &baseDir)

static XMLMemento::Pointer	CreateWriteRoot (const QString &type)

Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()

static Reflection::TypeInfo	GetStaticTypeInfo ()

static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()

Additional Inherited Members
Static Public Attributes inherited from berry::IMemento
static const QString	TAG_ID

Protected Member Functions inherited from berry::Object
	Object ()

virtual	~Object ()

virtual QDebug	PrintSelf (QDebug os, Indent indent) const

virtual QDebug	PrintHeader (QDebug os, Indent indent) const

virtual QDebug	PrintTrailer (QDebug os, Indent indent) const

Protected Attributes inherited from berry::Object
QAtomicInt	m_ReferenceCount

QMutex	m_ReferenceCountLock

Detailed Description

This class represents the default implementation of the IMemento interface.

This class is not intended to be extended by clients.

See also: IMemento

Definition at line 37 of file berryXMLMemento.h.

Member Typedef Documentation

◆ XMLByteInputStream

typedef std::istream berry::XMLMemento::XMLByteInputStream

Defines a std::istream as XML input stream

Definition at line 51 of file berryXMLMemento.h.

◆ XMLByteOutputStream

typedef std::ostream berry::XMLMemento::XMLByteOutputStream

Defines a std::ostream as XML output stream

Definition at line 46 of file berryXMLMemento.h.

Constructor & Destructor Documentation

◆ XMLMemento()

berry::XMLMemento::XMLMemento	(	Poco::XML::Document *	document,
		Poco::XML::Element *	elem
	)

Creates a memento for the specified document and element.

Clients should use CreateReadRoot and CreateWriteRoot to create the initial memento on a document.

Parameters

document	the document for the memento
element	the element node for the memento

Definition at line 34 of file berryXMLMemento.cpp.

Referenced by CopyChild(), CreateChild(), CreateReadRoot(), and CreateWriteRoot().

◆ ~XMLMemento()

berry::XMLMemento::~XMLMemento ( )

override

Definition at line 42 of file berryXMLMemento.cpp.

Member Function Documentation

◆ berryObjectMacro()

berry::XMLMemento::berryObjectMacro ( XMLMemento )

◆ CopyChild()

berry::IMemento::Pointer berry::XMLMemento::CopyChild ( IMemento::Pointer child )

Copies another Memento into this memento

Parameters

child the new child memento

Returns: the new child memento

Definition at line 126 of file berryXMLMemento.cpp.

References berry::SmartPointer< TObjectType >::Cast(), GetElement(), and XMLMemento().

◆ CreateChild() [1/2]

berry::IMemento::Pointer berry::XMLMemento::CreateChild ( const QString & type )

overridevirtual

Creates a new child of this memento with the given type

Parameters

type the type

Returns: a new child memento with the given type

Implements berry::IMemento.

Definition at line 107 of file berryXMLMemento.cpp.

References XMLMemento().

Referenced by GetAttributeKeys().

◆ CreateChild() [2/2]

berry::IMemento::Pointer berry::XMLMemento::CreateChild	(	const QString &	type,
		const QString &	id
	)

overridevirtual

Creates a new child of this memento with the given type and id. The id is stored in the child memento (using a special reserved key, TAG_ID) and can be retrieved using getId.

The getChild and getChildren methods are used to retrieve children of a given type.

Parameters

type	the type
id	the child id

Returns: a new child memento with the given type and id

See also: #getID

Implements berry::IMemento.

Definition at line 116 of file berryXMLMemento.cpp.

References berry::IMemento::TAG_ID, and XMLMemento().

◆ CreateReadRoot() [1/2]

berry::XMLMemento::Pointer berry::XMLMemento::CreateReadRoot ( berry::XMLMemento::XMLByteInputStream & reader )

static

Creates a Document from the Reader and returns a memento on the first Element for reading the document.

Parameters

reader the Reader used to create the memento's document

Returns: a memento on the first Element for reading the document

Exceptions

WorkbenchException if IO problems, invalid format, or no element.

Definition at line 48 of file berryXMLMemento.cpp.

◆ CreateReadRoot() [2/2]

berry::XMLMemento::Pointer berry::XMLMemento::CreateReadRoot	(	berry::XMLMemento::XMLByteInputStream &	reader,
		const QString &	baseDir
	)

static

Creates a Document from the Reader and returns a memento on the first Element for reading the document.

Parameters

reader	the `Reader` used to create the memento's document
baseDir	the directory used to resolve relative file names in the XML document. This directory must exist and include the trailing separator. The directory format, including the separators, must be valid for the platform. Can be `null` if not needed.

Returns: a memento on the first Element for reading the document

Exceptions

WorkbenchException if IO problems, invalid format, or no element.

Definition at line 54 of file berryXMLMemento.cpp.

References XMLMemento().

◆ CreateWriteRoot()

berry::XMLMemento::Pointer berry::XMLMemento::CreateWriteRoot ( const QString & type )

static

Returns a root memento for writing a document.

Parameters

type	the element node type to create on the document

Returns: the root memento for writing a document

Definition at line 90 of file berryXMLMemento.cpp.

References XMLMemento().

◆ GetAttributeKeys()

QList< QString > berry::XMLMemento::GetAttributeKeys ( ) const

overridevirtual

Returns an array of all the attribute keys of the memento. This will not be null. If there are no keys, an array of length zero will be returned.

Returns: an vector with all the attribute keys of the memento

Implements berry::IMemento.

Definition at line 272 of file berryXMLMemento.cpp.

References berry::SmartPointer< TObjectType >::Cast(), CreateChild(), PutString(), and PutTextData().

◆ GetBoolean()

bool berry::XMLMemento::GetBoolean	(	const QString &	key,
		bool &	value
	)		const

overridevirtual

See also: IMemento::GetString

Implements berry::IMemento.

Definition at line 233 of file berryXMLMemento.cpp.

◆ GetChild()

berry::IMemento::Pointer berry::XMLMemento::GetChild ( const QString & type ) const

overridevirtual

Returns the first child with the given type id.

Parameters

type	the type id

Returns: the first child with the given type

Implements berry::IMemento.

Definition at line 138 of file berryXMLMemento.cpp.

◆ GetChildren()

QList< berry::IMemento::Pointer > berry::XMLMemento::GetChildren ( const QString & type ) const

overridevirtual

Returns all children with the given type id.

Parameters

type	the type id

Returns: an array of children with the given type

Implements berry::IMemento.

Definition at line 152 of file berryXMLMemento.cpp.

◆ GetElement()

Poco::XML::Element * berry::XMLMemento::GetElement ( ) const

virtual

Returns the element of the memento

Returns: the xml element

Definition at line 426 of file berryXMLMemento.cpp.

Referenced by CopyChild(), and PutMemento().

◆ GetFloat()

bool berry::XMLMemento::GetFloat	(	const QString &	key,
		double &	value
	)		const

overridevirtual

See also: IMemento::GetFloat

Implements berry::IMemento.

Definition at line 169 of file berryXMLMemento.cpp.

References berry::WorkbenchPlugin::Log().

◆ GetID()

QString berry::XMLMemento::GetID ( ) const

overridevirtual

Returns the ID of this memento

Implements berry::IMemento.

Definition at line 207 of file berryXMLMemento.cpp.

References berry::IMemento::TAG_ID.

◆ GetInteger()

bool berry::XMLMemento::GetInteger	(	const QString &	key,
		int &	value
	)		const

overridevirtual

See also: IMemento::GetInteger

Implements berry::IMemento.

Definition at line 213 of file berryXMLMemento.cpp.

References berry::WorkbenchPlugin::Log().

◆ GetString()

bool berry::XMLMemento::GetString	(	const QString &	key,
		QString &	value
	)		const

overridevirtual

See also: IMemento::GetString

Implements berry::IMemento.

Definition at line 250 of file berryXMLMemento.cpp.

◆ GetTextData()

QString berry::XMLMemento::GetTextData ( ) const

overridevirtual

Returns the data of the Text node of the memento. Each memento is allowed only one Text node.

Returns: the data of the Text node of the memento, or null if the memento has no Text node.

Implements berry::IMemento.

Definition at line 260 of file berryXMLMemento.cpp.

References EMPTY_STRING.

◆ GetType()

QString berry::XMLMemento::GetType ( ) const

overridevirtual

Returns the Type of this memento

Implements berry::IMemento.

Definition at line 202 of file berryXMLMemento.cpp.

◆ PutBoolean()

void berry::XMLMemento::PutBoolean	(	const QString &	key,
		bool	value
	)

overridevirtual

Puts a boolean in this memento

Parameters

key	the key
value	the value

Implements berry::IMemento.

Definition at line 387 of file berryXMLMemento.cpp.

◆ PutFloat()

void berry::XMLMemento::PutFloat	(	const QString &	key,
		double	value
	)

overridevirtual

Puts a float in this memento

Parameters

key	the key
value	the value

Implements berry::IMemento.

Definition at line 359 of file berryXMLMemento.cpp.

◆ PutInteger()

void berry::XMLMemento::PutInteger	(	const QString &	key,
		int	value
	)

overridevirtual

Puts a integer in this memento

Parameters

key	the key
value	the value

Implements berry::IMemento.

Definition at line 365 of file berryXMLMemento.cpp.

◆ PutMemento()

void berry::XMLMemento::PutMemento ( IMemento::Pointer memento )

overridevirtual

Puts another memento in this memento as a child

Parameters

key	the key
value	the value

Implements berry::IMemento.

Definition at line 371 of file berryXMLMemento.cpp.

References berry::SmartPointer< TObjectType >::Cast(), and GetElement().

◆ PutString()

void berry::XMLMemento::PutString	(	const QString &	key,
		const QString &	value
	)

overridevirtual

Puts a string in this memento

Parameters

key	the key
value	the value

Implements berry::IMemento.

Definition at line 378 of file berryXMLMemento.cpp.

Referenced by GetAttributeKeys().

◆ PutTextData()

void berry::XMLMemento::PutTextData ( const QString & data )

overridevirtual

Puts a text in this memento

Parameters

data the text

Implements berry::IMemento.

Definition at line 399 of file berryXMLMemento.cpp.

Referenced by GetAttributeKeys().

◆ Save()

void berry::XMLMemento::Save ( XMLByteOutputStream & writer )

Saves this memento's document current values to the specified writer.

Parameters

writer the writer used to save the memento's document

Exceptions

IOException if there is a problem serializing the document to the stream.

Definition at line 413 of file berryXMLMemento.cpp.

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ XMLByteInputStream

◆ XMLByteOutputStream

Constructor & Destructor Documentation

◆ XMLMemento()

◆ ~XMLMemento()

Member Function Documentation

◆ berryObjectMacro()

◆ CopyChild()

◆ CreateChild() [1/2]

◆ CreateChild() [2/2]

◆ CreateReadRoot() [1/2]

◆ CreateReadRoot() [2/2]

◆ CreateWriteRoot()

◆ GetAttributeKeys()

◆ GetBoolean()

◆ GetChild()

◆ GetChildren()

◆ GetElement()

◆ GetFloat()

◆ GetID()

◆ GetInteger()

◆ GetString()

◆ GetTextData()

◆ GetType()

◆ PutBoolean()

◆ PutFloat()

◆ PutInteger()

◆ PutMemento()

◆ PutString()

◆ PutTextData()

◆ Save()