dk.heick.properties.collections

Class PropertyCollectionRegistry

java.lang.Object

dk.heick.properties.collections.PropertyCollectionRegistry

All Implemented Interfaces:

Serializable

public final class PropertyCollectionRegistry
extends Object
implements Serializable

Static class which holds PropertyCollections.
PropertyCollections are registered here at constructor time and is stored in a Synchronized WeakHashMap.
A PropertyCollection is registered by it class name "PropertyCollection.getName()".

IMPORTANT: This registry will shared across the VM, so if different application or areas or not allowed to see eachother collections, then either remove the collection in the constructor, or turn of collection registry.
Example:

        public void preValidation() {                   
                PropertyCollectionRegistry.removeRegister(this);
        }
 

Example:

        public void preValidation() {                   
                PropertyFrameworkGlobals.setAutoRegisterPropertyCollections(false);
        }
 

Example:

  public class MyPropertiesDemo extends PropertyExposedFinalFieldCollection implements MarkerNoPropertyCollectionRegistry {
  
        private MyPropertiesDemo(ManifestPropertyIO io) {
                super(io);
        }       
        
        public static MyPropertiesDemo getInstance(ManifestPropertyIO io) {
                MyPropertiesDemo collection = new MyPropertiesDemo(io);
                PropertyFieldCollection.initialize(collection); 
                return collection;
        }
  
        public static MyPropertiesDemo getInstance() {
                return getInstance(new ManifestPropertyIO());
        }                       
  }
 

Example:

  public class MyPropertiesDemo extends PropertyExposedFinalFieldCollection  {
  
        private MyPropertiesDemo(ManifestPropertyIO io) {
                super(io);
        }       
        
        public static MyPropertiesDemo getInstance(ManifestPropertyIO io) {
                MyPropertiesDemo collection = new MyPropertiesDemo(io);
                PropertyFieldCollection.initialize(collection); 
                return collection;
        }
  
        public static MyPropertiesDemo getInstance() {
                return getInstance(new ManifestPropertyIO());
        }       
        public long getRegistryTimeout() {
                return 0; //PropertyCollection.PROPERTY_REGISTRY_DO_NOT_REGISTER
        }
  }
 

hest

Since:

1.7

Author:

Frederik Heick

See Also:

removeRegister(PropertyCollection), PropertyFrameworkGlobals.setAutoRegisterPropertyCollections(boolean), PropertyCollection.preValidation(), PropertyCollection.postValidation(), PropertyCollection.getRegistryTimeout(), MarkerNoPropertyCollectionRegistry, PropertyCollection.getName(), Serialized Form

Method Summary

Modifier and Type	Method and Description
static void	clearRegistry() Clears all registered PropertyCollections from the registry.
static PropertyCollection	getCollection(String key) Gets a PropertyCollection by its key.
static Date	getLastUpdated() The last datetime when the PropertyCollectionRegistry was updated.
static Iterator<String>	getRegisteredCollections() Gets an iterator over all registered PropertyCollection keys.
static void	refreshRegistry() Refresh the registry, and removes all the PropertyCollections who has timedout.
static void	register(PropertyCollection collection) Register a PropertyCollection, using its "getName" as key.
static void	removeRegister(PropertyCollection collection) Removes a PropertyCollection from the registry.
static int	size() Gets the number of registered PropertyCollections.
static int	size(String key) Gets the number of Property's in a PropertyCollection.

Methods inherited from class java.lang.Object

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

Method Detail

getLastUpdated

public static final Date getLastUpdated()

The last datetime when the PropertyCollectionRegistry was updated. Initial it is

Date(0)

.

Returns:

the lastUpdated for PropertyCollectionRegistry.

register

public static final void register(PropertyCollection collection)
                           throws NullPointerException

Register a PropertyCollection, using its "getName" as key.

Parameters:

collection - the PropertyCollection.

Throws:

NullPointerException - if collection is null.

removeRegister

public static final void removeRegister(PropertyCollection collection)
                                 throws NullPointerException

Removes a PropertyCollection from the registry.

Parameters:

collection - a PropertyCollection

Throws:

NullPointerException - if collection is null.

getRegisteredCollections

public static final Iterator<String> getRegisteredCollections()

Gets an iterator over all registered PropertyCollection keys.

Returns:

an iterator of collection keys.

getCollection

public static final PropertyCollection getCollection(String key)

Gets a PropertyCollection by its key.

Parameters:

key - the key that uniquely identifies the PropertyCollection.

Returns:

if a PropertyCollection is found by its key, than it is returned, otherwise null.

size

public static final int size()

Gets the number of registered PropertyCollections.

Returns:

the number of registered collections.

size

public static final int size(String key)

Gets the number of Property's in a PropertyCollection.

Parameters:

key - the key that uniquely identifies the PropertyCollection.

Returns:

if a PropertyCollection is found by the key, the number of Property's in the collection is returned, otherwise 0 is returned.

clearRegistry

public static final void clearRegistry()

Clears all registered PropertyCollections from the registry.

refreshRegistry

public static final void refreshRegistry()

Refresh the registry, and removes all the PropertyCollections who has timedout.