org.eclipse.emf.ecp.internal.core.util

Class Properties

java.lang.Object

org.eclipse.net4j.util.event.Notifier

org.eclipse.net4j.util.lifecycle.Lifecycle

org.eclipse.emf.ecp.internal.core.util.Registry<Map.Entry<String,String>,ECPPropertiesObserver>

org.eclipse.emf.ecp.internal.core.util.Properties

All Implemented Interfaces:

ECPProperties, ECPDisposable.DisposeListener, org.eclipse.net4j.util.event.INotifier, org.eclipse.net4j.util.lifecycle.IDeactivateable, org.eclipse.net4j.util.lifecycle.ILifecycle, org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation

public class Properties
extends Registry<Map.Entry<String,String>,ECPPropertiesObserver>
implements ECPProperties

Author:

Eike Stepper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Properties.Property

Nested classes/interfaces inherited from interface org.eclipse.net4j.util.lifecycle.ILifecycle

org.eclipse.net4j.util.lifecycle.ILifecycle.DeferrableActivation

Field Summary

Fields inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle

USE_LABEL

Constructor Summary

Constructors

Constructor and Description
Properties() Default constructor.
Properties(ObjectInput in)

Method Summary

Modifier and Type	Method and Description
void	addProperty(String key, String value) Adds a key-value-pair.
ECPProperties	copy() Creates a copy of the current set of properties.
protected String	getElementName(Map.Entry<String,String> element)
protected Collection<Map.Entry<String,String>>	getElementsToWrite()
Set<String>	getKeys() All stored keys.
Collection<Map.Entry<String,String>>	getProperties() All Properties.
String	getValue(String name) Get the value of a property identified by this key.
boolean	hasProperties() Whether any properties are stored.
protected void	notifyObservers(Collection<Map.Entry<String,String>> oldProperties, Collection<Map.Entry<String,String>> newProperties) Notifies observers that the elements in the registry have changed.
void	removeProperty(String key) Removes a property.
void	write(ObjectOutput out)

Methods inherited from class org.eclipse.emf.ecp.internal.core.util.Registry

addObserver, changeElements, disposed, doChangeElements, elementsChanged, getElement, getElementCount, getElementNames, getElements, hasElement, hasElements, isDisposingElement, isRemoveDisposedElements, removeObserver

Methods inherited from class org.eclipse.net4j.util.lifecycle.Lifecycle

activate, checkActive, checkArg, checkArg, checkInactive, checkNull, checkState, checkState, deactivate, deferredActivate, doActivate, doAfterActivate, doBeforeActivate, doBeforeDeactivate, doDeactivate, dump, getLifecycleState, isActive, isDeferredActivation, toString

Methods inherited from class org.eclipse.net4j.util.event.Notifier

addListener, fireEvent, fireEvent, fireEvent, fireThrowable, firstListenerAdded, getListeners, getNotificationService, hasListeners, lastListenerRemoved, removeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.emf.ecp.core.util.ECPProperties

addObserver, removeObserver

Methods inherited from interface org.eclipse.net4j.util.event.INotifier

addListener, getListeners, hasListeners, removeListener

Constructor Detail

Properties

public Properties()

Default constructor.

Properties

public Properties(ObjectInput in)
           throws IOException

Throws:

IOException

Method Detail

write

public void write(ObjectOutput out)
           throws IOException

Throws:

IOException

addProperty

public void addProperty(String key,
                        String value)

Adds a key-value-pair.

Specified by:

addProperty in interface ECPProperties

Parameters:

key - the key of the property

value - the value of the property

removeProperty

public void removeProperty(String key)

Removes a property.

Specified by:

removeProperty in interface ECPProperties

Parameters:

key - of the property to remove

getValue

public String getValue(String name)

Get the value of a property identified by this key.

Specified by:

getValue in interface ECPProperties

Parameters:

name - the key of the property to find

Returns:

the value of the property identified by the key or null

getKeys

public Set<String> getKeys()

All stored keys.

Specified by:

getKeys in interface ECPProperties

Returns:

an array of all keys

getProperties

public Collection<Map.Entry<String,String>> getProperties()

All Properties.

Specified by:

getProperties in interface ECPProperties

Returns:

an array of Key-Value-Pairs

hasProperties

public boolean hasProperties()

Whether any properties are stored.

Specified by:

hasProperties in interface ECPProperties

Returns:

true if at least 1 property was added, false otherwise

copy

public ECPProperties copy()

Creates a copy of the current set of properties.

Specified by:

copy in interface ECPProperties

Returns:

the copy of the current properties

getElementName

protected String getElementName(Map.Entry<String,String> element)

Specified by:

getElementName in class Registry<Map.Entry<String,String>,ECPPropertiesObserver>

Parameters:

element - the element to retrieve a name for.

Returns:

the name of an element

getElementsToWrite

protected Collection<Map.Entry<String,String>> getElementsToWrite()

notifyObservers

protected void notifyObservers(Collection<Map.Entry<String,String>> oldProperties,
                               Collection<Map.Entry<String,String>> newProperties)
                        throws Exception

Description copied from class: Registry

Notifies observers that the elements in the registry have changed.

Specified by:

notifyObservers in class Registry<Map.Entry<String,String>,ECPPropertiesObserver>

Parameters:

oldProperties - The old collection of elements

newProperties - The new collection of elements

Throws:

Exception