#include <berryIPreferences.h>

Inheritance diagram for berry::IPreferences:

Collaboration diagram for berry::IPreferences:

Public Types
typedef berry::IPreferences	Self

typedef berry::SmartPointer< Self >	Pointer

typedef berry::SmartPointer< const Self >	ConstPointer

typedef berry::WeakPointer< Self >	WeakPtr

typedef berry::WeakPointer< const Self >	ConstWeakPtr

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
virtual	~IPreferences ()

virtual void	Put (const QString &key, const QString &value)=0

virtual QString	Get (const QString &key, const QString &def) const =0

virtual void	Remove (const QString &key)=0

virtual void	Clear ()=0

virtual void	PutInt (const QString &key, int value)=0

virtual int	GetInt (const QString &key, int def) const =0

virtual void	PutLong (const QString &key, long value)=0

virtual long	GetLong (const QString &key, long def) const =0

virtual void	PutBool (const QString &key, bool value)=0

virtual bool	GetBool (const QString &key, bool def) const =0

virtual void	PutFloat (const QString &key, float value)=0

virtual float	GetFloat (const QString &key, float def) const =0

virtual void	PutDouble (const QString &key, double value)=0

virtual double	GetDouble (const QString &key, double def) const =0

virtual void	PutByteArray (const QString &key, const QByteArray &value)=0

virtual QByteArray	GetByteArray (const QString &key, const QByteArray &def) const =0

virtual QStringList	Keys () const =0

virtual QStringList	ChildrenNames () const =0

virtual IPreferences::Pointer	Parent () const =0

virtual IPreferences::Pointer	Node (const QString &pathName)=0

virtual bool	NodeExists (const QString &pathName) const =0

virtual void	RemoveNode ()=0

virtual QString	Name () const =0

virtual QString	AbsolutePath () const =0

virtual void	Flush ()=0

virtual void	Sync ()=0

virtual void	BlockSignals (bool block)=0

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 const char *	GetStaticClassName ()

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

static Reflection::TypeInfo	GetStaticTypeInfo ()

static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()

Additional Inherited Members
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

A node in a hierarchical collection of preference data.

This interface allows applications to store and retrieve user and system preference data. This data is stored persistently in an implementation-dependent backing store. Typical implementations include flat files, OS-specific registries, directory servers and SQL databases.

For each bundle, there is a separate tree of nodes for each user, and one for system preferences. The precise description of "user" and "system" will vary from one bundle to another. Typical information stored in the user preference tree might include font choice, and color choice for a bundle which interacts with the user via a servlet. Typical information stored in the system preference tree might include installation data, or things like high score information for a game program.

Nodes in a preference tree are named in a similar fashion to directories in a hierarchical file system. Every node in a preference tree has a node name (which is not necessarily unique), a unique absolute path name , and a path name relative to each ancestor including itself.

The root node has a node name of the empty QString object (""). Every other node has an arbitrary node name, specified at the time it is created. The only restrictions on this name are that it cannot be the empty string, and it cannot contain the slash character ('/').

The root node has an absolute path name of "/". Children of the root node have absolute path names of "/" + <node name> . All other nodes have absolute path names of <parent's absolute path name> + "/" + <node name> . Note that all absolute path names begin with the slash character.

A node n 's path name relative to its ancestor a is simply the string that must be appended to a 's absolute path name in order to form n 's absolute path name, with the initial slash character (if present) removed. Note that:

No relative path names begin with the slash character.
Every node's path name relative to itself is the empty string.
Every node's path name relative to its parent is its node name (except for the root node, which does not have a parent).
Every node's path name relative to the root is its absolute path name with the initial slash character removed.

Note finally that:

No path name contains multiple consecutive slash characters.
No path name with the exception of the root's absolute path name end in the slash character.
Any string that conforms to these two rules is a valid path name.

Each Preference node has zero or more properties associated with it, where a property consists of a name and a value. The bundle writer is free to choose any appropriate names for properties. Their values can be of type QString,long,int,bool, std::vector<char>,float, or double but they can always be accessed as if they were QString objects.

All node name and property name comparisons are case-sensitive.

All of the methods that modify preference data are permitted to operate asynchronously; they may return immediately, and changes will eventually propagate to the persistent backing store, with an implementation-dependent delay. The flush method may be used to synchronously force updates to the backing store.

Implementations must automatically attempt to flush to the backing store any pending updates for a bundle's preferences when the bundle is stopped or otherwise ungets the IPreferences Service.

The methods in this class may be invoked concurrently by multiple threads in a single Java Virtual Machine (JVM) without the need for external synchronization, and the results will be equivalent to some serial execution. If this class is used concurrently by multiple JVMs that store their preference data in the same backing store, the data store will not be corrupted, but no other guarantees are made concerning the consistency of the preference data.

Version: $Revision$

Definition at line 123 of file berryIPreferences.h.

Member Typedef Documentation

typedef berry::SmartPointer<const Self> berry::IPreferences::ConstPointer

Definition at line 125 of file berryIPreferences.h.

typedef berry::WeakPointer<const Self> berry::IPreferences::ConstWeakPtr

Definition at line 125 of file berryIPreferences.h.

typedef berry::SmartPointer<Self> berry::IPreferences::Pointer

Definition at line 125 of file berryIPreferences.h.

typedef berry::IPreferences berry::IPreferences::Self

Definition at line 125 of file berryIPreferences.h.

typedef berry::WeakPointer<Self> berry::IPreferences::WeakPtr

Definition at line 125 of file berryIPreferences.h.

Constructor & Destructor Documentation

berry::IPreferences::~IPreferences ( )

virtual

Definition at line 21 of file berryIPreferences.cpp.

Member Function Documentation

virtual QString berry::IPreferences::AbsolutePath ( ) const

pure virtual

Returns this node's absolute path name. Note that:

Root node - The path name of the root node is "/".
Slash at end - Path names other than that of the root node may not end in slash ('/').
Unusual names -"." and ".." have no special significance in path names.
Illegal names - The only illegal path names are those that contain multiple consecutive slashes, or that end in slash and are not the root.

Returns: this node's absolute path name.

virtual void berry::IPreferences::BlockSignals ( bool block )

pure virtual

Sets a flag to the parameter block which can be used to block berry messages in order to prevent callback functions to be called.

Parameters

block boolean to set the flag

virtual QStringList berry::IPreferences::ChildrenNames ( ) const

pure virtual

Returns the names of the children of this node. (The returned array will be of size zero if this node has no children and not null!)

Returns: the names of the children of this node.

Exceptions

BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

virtual void berry::IPreferences::Clear ( )

pure virtual

Removes all of the properties (key-value associations) in this node. This call has no effect on any descendants of this node.

Exceptions

BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #remove(const QString&)

virtual void berry::IPreferences::Flush ( )

pure virtual

Forces any changes in the contents of this node and its descendants to the persistent store.

Once this method returns successfully, it is safe to assume that all changes made in the subtree rooted at this node prior to the method invocation have become permanent.

Implementations are free to flush changes into the persistent store at any time. They do not need to wait for this method to be called.

When a flush occurs on a newly created node, it is made persistent, as are any ancestors (and descendants) that have yet to be made persistent. Note however that any properties value changes in ancestors are not guaranteed to be made persistent.

Exceptions

BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #sync()

virtual QString berry::IPreferences::Get	(	const QString &	key,
		const QString &	def
	)		const

pure virtual

Returns the value associated with the specified key in this node. Returns the specified default if there is no value associated with the key, or the backing store is inaccessible.

Parameters

key	key whose associated value is to be returned.
def	the value to be returned in the event that this node has no value associated with `key` or the backing store is inaccessible.

Returns: the value associated with key, or def if no value is associated with key.

Exceptions

IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.
NullPointerException	if `key` is `null`. (A `null` default is permitted.)

Referenced by QmitkStdMultiWidgetEditor::GetPreferenceDecorations(), and QmitkStdMultiWidgetEditor::OnPreferencesChanged().

virtual bool berry::IPreferences::GetBool	(	const QString &	key,
		bool	def
	)		const

pure virtual

Returns the bool value represented by the QString object associated with the specified key in this node. Valid strings are "true", which represents true, and "false", which represents false. Case is ignored, so, for example, "TRUE" and "False" are also valid. This method is intended for use in conjunction with the putBoolmethod.

Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if the associated value is something other than "true" or "false", ignoring case.

Parameters

key	`key` whose associated value is to be returned as a `bool`.
def	the value to be returned in the event that this node has no value associated with `key` or the associated value cannot be interpreted as a `bool` or the backing store is inaccessible.

Returns: the bool value represented by the std::string object associated with key in this node, or null if the associated value does not exist or cannot be interpreted as a bool.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #get(const QString&,const QString&); #putBool(const QString&,bool)

Referenced by QmitkStdMultiWidgetEditor::OnPreferencesChanged(), and QmitkDataManagerView::OnPreferencesChanged().

virtual QByteArray berry::IPreferences::GetByteArray	(	const QString &	key,
		const QByteArray &	def
	)		const

pure virtual

Returns the QByteArray value represented by the QString object associated with the specified key in this node. Valid QString objects are Base64 encoded binary data, as defined in RFC 2045 , Section 6.8, with one minor change: the string must consist solely of characters from the Base64 Alphabet ; no newline characters or extraneous characters are permitted. This method is intended for use in conjunction with the putByteArraymethod.

Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if the associated value is not a valid Base64 encoded byte array (as defined above).

Parameters

key	`key` whose associated value is to be returned as a `std::vector<char>` object.
def	the value to be returned in the event that this node has no value associated with `key` or the associated value cannot be interpreted as a `std::vector<char>` type, or the backing store is inaccessible.

Returns: the std::vector<char> value represented by the QString object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a std::vector<char>.

Exceptions

NullPointerException	if `key` is `null`. (A `null` value for `def` is permitted.)
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #get(const QString&,const QString&); #putByteArray(const QString&,std::vector<char>)

virtual double berry::IPreferences::GetDouble	(	const QString &	key,
		double	def
	)		const

pure virtual

Returns the double value represented by the QString object associated with the specified key in this node. The QString object is converted to a double value as by Double.parseDouble(QString). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Double.parseDouble(QString) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the putDoublemethod.

Parameters

key	`key` whose associated value is to be returned as a `double` value.
def	the value to be returned in the event that this node has no value associated with `key` or the associated value cannot be interpreted as a `double` type or the backing store is inaccessible.

Returns: the double value represented by the QString object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a double type.

Exceptions

IllegalStateException	if this node (or an ancestor) has been removed with the the removeNode()method.
NullPointerException	if `key` is `null`.

See also: #putDouble(const QString&,double); #get(const QString&,const QString&)

virtual float berry::IPreferences::GetFloat	(	const QString &	key,
		float	def
	)		const

pure virtual

Returns the float value represented by the QString object associated with the specified key in this node. The QString object is converted to a float value as by Float.parseFloat(QString). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Float.parseFloat(QString) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the putFloat method.

Parameters

key	`key` whose associated value is to be returned as a `float` value.
def	the value to be returned in the event that this node has no value associated with `key` or the associated value cannot be interpreted as a `float` type or the backing store is inaccessible.

Returns: the float value represented by the string associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a float type.

Exceptions

IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.
NullPointerException	if `key` is `null`.

See also: #putFloat(const QString&,float); #get(const QString&,const QString&)

virtual int berry::IPreferences::GetInt	(	const QString &	key,
		int	def
	)		const

pure virtual

Returns the int value represented by the QString object associated with the specified key in this node. The QString object is converted to an int as by Integer.parseInt(QString). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Integer.parseInt(QString) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the putIntmethod.

Parameters

key	key whose associated value is to be returned as an `int`.
def	the value to be returned in the event that this node has no value associated with `key` or the associated value cannot be interpreted as an `int` or the backing store is inaccessible.

Returns: the int value represented by the QString object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as an int type.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #putInt(const QString&,int); #get(const QString&,const QString&)

Referenced by QmitkStdMultiWidgetEditor::OnPreferencesChanged().

virtual long berry::IPreferences::GetLong	(	const QString &	key,
		long	def
	)		const

pure virtual

Returns the long value represented by the QString object associated with the specified key in this node. The QString object is converted to a long as by Long.parseLong(QString). Returns the specified default if there is no value associated with the key, the backing store is inaccessible, or if Long.parseLong(QString) would throw a NumberFormatException if the associated value were passed. This method is intended for use in conjunction with the putLongmethod.

Parameters

key	`key` whose associated value is to be returned as a `long` value.
def	the value to be returned in the event that this node has no value associated with `key` or the associated value cannot be interpreted as a `long` type or the backing store is inaccessible.

Returns: the long value represented by the QString object associated with key in this node, or def if the associated value does not exist or cannot be interpreted as a long type.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #putLong(const QString&,long); #get(const QString&,const QString&)

static const char* berry::IPreferences::GetStaticClassName ( )

inlinestatic

Definition at line 125 of file berryIPreferences.h.

virtual QStringList berry::IPreferences::Keys ( ) const

pure virtual

Returns all of the keys that have an associated value in this node. (The returned array will be of size zero if this node has no preferences and not null!)

Returns: an array of the keys that have an associated value in this node.

Exceptions

BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

Referenced by QmitkStdMultiWidgetEditor::OnPreferencesChanged().

virtual QString berry::IPreferences::Name ( ) const

pure virtual

Returns this node's name, relative to its parent.

Returns: this node's name, relative to its parent.

virtual IPreferences::Pointer berry::IPreferences::Node ( const QString & pathName )

pure virtual

Returns a named IPreferences object (node), creating it and any of its ancestors if they do not already exist. Accepts a relative or absolute pathname. Absolute pathnames (which begin with '/') are interpreted relative to the root of this node. Relative pathnames (which begin with any character other than '/') are interpreted relative to this node itself. The empty string ("") is a valid relative pathname, referring to this node itself.

If the returned node did not exist prior to this call, this node and any ancestors that were created by this call are not guaranteed to become persistent until the flush method is called on the returned node (or one of its descendants).

Parameters

pathName the path name of the IPreferences object to return.

Returns: the specified IPreferences object.

Exceptions

IllegalArgumentException	if the path name is invalid.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.
NullPointerException	if path name is `null`.

See also: #flush()

virtual bool berry::IPreferences::NodeExists ( const QString & pathName ) const

pure virtual

Returns true if the named node exists. Accepts a relative or absolute pathname. Absolute pathnames (which begin with '/') are interpreted relative to the root of this node. Relative pathnames (which begin with any character other than '/') are interpreted relative to this node itself. The pathname "" is valid, and refers to this node itself.

If this node (or an ancestor) has already been removed with the removeNode()method, it is legal to invoke this method, but only with the pathname ""; the invocation will return false. Thus, the idiom p.nodeExists("") may be used to test whether p has been removed.

Parameters

pathName the path name of the node whose existence is to be checked.

Returns: true if the specified node exists.

Exceptions

BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method and `pathname` is not the empty string (`""`).
IllegalArgumentException	if the path name is invalid (i.e., it contains multiple consecutive slash characters, or ends with a slash character and is more than one character long).

virtual IPreferences::Pointer berry::IPreferences::Parent ( ) const

pure virtual

Returns the parent of this node, or null if this is the root.

Returns: the parent of this node.

Exceptions

IllegalStateException if this node (or an ancestor) has been removed with the removeNode()method.

Referenced by QmitkStdMultiWidgetEditor::OnPreferencesChanged().

virtual void berry::IPreferences::Put	(	const QString &	key,
		const QString &	value
	)

pure virtual

Associates the specified value with the specified key in this node.

Parameters

key	key with which the specified value is to be associated.
value	value to be associated with the specified key.

Exceptions

NullPointerException	if `key` or `value` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

Referenced by QmitkStdMultiWidgetEditor::InitializePreferences().

virtual void berry::IPreferences::PutBool	(	const QString &	key,
		bool	value
	)

pure virtual

Associates a QString object representing the specified bool value with the specified key in this node. The associated string is "true" if the value is true, and "false" if it is false. This method is intended for use in conjunction with the getBoolmethod.

Implementor's note: it is not necessary that the value be represented by a string in the backing store. If the backing store supports bool values, it is not unreasonable to use them. This implementation detail is not visible through the IPreferences API, which allows the value to be read as a bool (with getBool) or a QString (with get) type.

Parameters

key	`key` with which the string form of value is to be associated.
value	value whose string form is to be associated with `key`.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #getBool(const QString&,bool); #get(const QString&,const QString&)

virtual void berry::IPreferences::PutByteArray	(	const QString &	key,
		const QByteArray &	value
	)

pure virtual

Associates a QByteArray object representing the specified QByteArray with the specified key in this node. The associated QByteArray object is stored in Base64 encoding. This method is intended for use in conjunction with the getByteArraymethod.

Parameters

key	`key` with which the string form of `value` is to be associated.
value	`value` whose string form is to be associated with `key`.

Exceptions

NullPointerException	if `key` or `value` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #GetByteArray(const QString&,const QByteArray&); #Get(const QString&,const QString&)

virtual void berry::IPreferences::PutDouble	(	const QString &	key,
		double	value
	)

pure virtual

Associates a QString object representing the specified double value with the specified key in this node. The associated QString object is the one that would be returned if the double value were passed to Double.toString(double). This method is intended for use in conjunction with the getDoublemethod

Implementor's note: it is not necessary that the value be represented by a string in the backing store. If the backing store supports double values, it is not unreasonable to use them. This implementation detail is not visible through the IPreferences API, which allows the value to be read as a double (with getDouble) or a QString (with get) type.

Parameters

key	`key` with which the string form of value is to be associated.
value	value whose string form is to be associated with `key`.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #getDouble(const QString&,double)

virtual void berry::IPreferences::PutFloat	(	const QString &	key,
		float	value
	)

pure virtual

Associates a QString object representing the specified float value with the specified key in this node. The associated QString object is the one that would be returned if the float value were passed to Float.toString(float). This method is intended for use in conjunction with the getFloatmethod.

Implementor's note: it is not necessary that the value be represented by a string in the backing store. If the backing store supports float values, it is not unreasonable to use them. This implementation detail is not visible through the IPreferences API, which allows the value to be read as a float (with getFloat) or a QString (with get) type.

Parameters

key	`key` with which the string form of value is to be associated.
value	value whose string form is to be associated with `key`.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #getFloat(const QString&,float)

virtual void berry::IPreferences::PutInt	(	const QString &	key,
		int	value
	)

pure virtual

Associates a QString object representing the specified int value with the specified key in this node. The associated string is the one that would be returned if the int value were passed to Integer.toString(int). This method is intended for use in conjunction with getIntmethod.

Implementor's note: it is not necessary that the property value be represented by a QString object in the backing store. If the backing store supports integer values, it is not unreasonable to use them. This implementation detail is not visible through the IPreferences API, which allows the value to be read as an int (with getInt or a QString (with get) type.

Parameters

key	key with which the string form of value is to be associated.
value	`value` whose string form is to be associated with `key`.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #getInt(const QString&,int)

virtual void berry::IPreferences::PutLong	(	const QString &	key,
		long	value
	)

pure virtual

Associates a QString object representing the specified long value with the specified key in this node. The associated QString object is the one that would be returned if the long value were passed to Long.toString(long). This method is intended for use in conjunction with the getLong method.

Implementor's note: it is not necessary that the value be represented by a QString type in the backing store. If the backing store supports long values, it is not unreasonable to use them. This implementation detail is not visible through the IPreferences API, which allows the value to be read as a long (with getLong or a QString (with get) type.

Parameters

key	`key` with which the string form of `value` is to be associated.
value	`value` whose string form is to be associated with `key`.

Exceptions

NullPointerException	if `key` is `null`.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #getLong(const QString&,long)

virtual void berry::IPreferences::Remove ( const QString & key )

pure virtual

Removes the value associated with the specified key in this node, if any.

Parameters

key	key whose mapping is to be removed from this node.

See also: #get(const QString&,const QString&)

Exceptions

IllegalStateException if this node (or an ancestor) has been removed with the removeNode()method.

virtual void berry::IPreferences::RemoveNode ( )

pure virtual

Removes this node and all of its descendants, invalidating any properties contained in the removed nodes. Once a node has been removed, attempting any method other than name(),absolutePath() or nodeExists("") on the corresponding IPreferences instance will fail with an IllegalStateException. (The methods defined on Object can still be invoked on a node after it has been removed; they will not throw IllegalStateException.)

The removal is not guaranteed to be persistent until the flush method is called on the parent of this node.

Exceptions

IllegalStateException	if this node (or an ancestor) has already been removed with the removeNode()method.
BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.

See also: #flush()

virtual void berry::IPreferences::Sync ( )

pure virtual

Ensures that future reads from this node and its descendants reflect any changes that were committed to the persistent store (from any VM) prior to the sync invocation. As a side-effect, forces any changes in the contents of this node and its descendants to the persistent store, as if the flush method had been invoked on this node.

Exceptions

BackingStoreException	if this operation cannot be completed due to a failure in the backing store, or inability to communicate with it.
IllegalStateException	if this node (or an ancestor) has been removed with the removeNode()method.

See also: #flush()

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation