PropertyCollection (JHPropertiesTyped

All Superinterfaces:

Serializable

All Known Implementing Classes:

GlobalPropertiesStaticResourceCollection, ManifestMainCollection, PropertyExposedFieldCollection, PropertyExposedFinalFieldCollection, PropertyFieldCollection, PropertyFrameworkGlobals.GlobalPropertyStaticCollection, PropertyListCollection, PropertyStaticCollection, SystemPropertiesCollection
```
public interface PropertyCollection
extends Serializable
```
An interface which holds a collection of Property's.
Which is initialized with a PropertyIO.
Remember to implement rules from static configuration PropertyFrameworkGlobals.
In the constructor of the PropertyCollection, do call the method "PropertyCollectionRegistry.register(this);", there by we can get all different collection using the PropertyCollectionRegistry.

Since:

1.0

Version:

1.0

Author:

Frederik Heick

See Also:

Property, PropertyIO, PropertyFrameworkGlobals, PropertyCollectionRegistry

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`PROPERTY_REGISTRY_DO_NOT_REGISTER` The value set for "getRegistryTimeout" if the PropertyCollection should not be registered on PropertyCollectionRegistry.
`static long`	`PROPERTY_REGISTRY_NO_TIMEOUT` The value set for "getRegistryTimeout" if the PropertyCollection should never timeout in PropertyCollectionRegistry (DEFAULT value).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a `PropertyChangeListener` to all registrered Property's in the PropertyCollection.
`PropertyIO`	`getIo()` The PropertyIO.
`Iterator<Property<?>>`	`getIterator()` Property Iterator.
`List<Property<?>>`	`getList()` Property list sorted by name, as a `Collections.unmodifiableList`.
`org.apache.commons.logging.Log`	`getLogger()` The `org.apache.commons.logging.Log` used.
`String`	`getName()` Gets the name of the collection, default is `getClass().getName();`.
`Property<?>`	`getPropertyByName(String propertyName)` Get a Property by name.
`PropertyValidationHandler`	`getPropertyValidationHandler()` When a property collection validates all the properties it contains, then this handler defines what happens in case the a property is valid or invalid.
`long`	`getRegistryTimeout()` The number of milliseconds before a PropertyCollection is automatically remove from `PropertyCollectionRegistry`.
`void`	`postValidation()` After the PropertyCollection has validation the PropertyIO and all the Properties, it calls this method.
`void`	`preValidation()` This method is called before any validation of PropertyIO and Properties is performed, this is where you typically can setup global configurations.
`void`	`reload()` Resets the cache typed values for all the `Property`'s in the PropertyIO for this collection which forces a reload from the property IO.
`void`	`removeAllPropertyChangeListeners()` Remove all `PropertyChangeListener`'s from the Property's in the Collection.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a `PropertyChangeListener` from all registered Property's in the collection.
`void`	`setPropertyValidationHandler(PropertyValidationHandler propertyValidationHandler)` Here you can set your PropertyValidationHandler instance.
`int`	`size()` Number of properties.
`void`	`validate()` Validates all the `Property`'s in the collection an throws an `PropertyException` for the first that failsvalidation.
`List<PropertyValidationVO>`	`validation()` Validates all the `Property`'s in the collection, stores the result in a `java.util.List` of `PropertyValidationVO`.

- Field Detail
  - PROPERTY_REGISTRY_NO_TIMEOUT
```
static final long PROPERTY_REGISTRY_NO_TIMEOUT
```
    The value set for "getRegistryTimeout" if the PropertyCollection should never timeout in PropertyCollectionRegistry (DEFAULT value).
    
    See Also:
    
    Constant Field Values
  - PROPERTY_REGISTRY_DO_NOT_REGISTER
```
static final long PROPERTY_REGISTRY_DO_NOT_REGISTER
```
    The value set for "getRegistryTimeout" if the PropertyCollection should not be registered on PropertyCollectionRegistry.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Gets the name of the collection, default is getClass().getName();.
    
    Returns:
    
    the name of the collection, which is use to stored in PropertyCollectionRegistry
    
    Since:
    
    1.9
  - getRegistryTimeout
```
long getRegistryTimeout()
```
    The number of milliseconds before a PropertyCollection is automatically remove from PropertyCollectionRegistry. There are three types of values:
    - Value < 0 : Has no timeout, an is stored indefinably in PropertyCollectionRegistry, until forcefully removed. (This is the DEFAULT value)
    - Value = 0 : Is never stored in PropertyCollectionRegistry
    - Value > 0 : Is stored the amount of milliseconds.
    Returns:
    
    the number of milliseconds before a PropertyCollection is automatically remove from PropertyCollectionRegistry.
    
    Since:
    
    1.9
    
    See Also:
    
    PropertyCollectionRegistry
  - reload
```
void reload()
```
    Resets the cache typed values for all the Property's in the PropertyIO for this collection which forces a reload from the property IO.
  - size
```
int size()
```
    Number of properties.
    
    Returns:
    
    the number of Property's in the collection.
  - validate
```
void validate()
       throws PropertyException
```
    Validates all the Property's in the collection an throws an PropertyException for the first that failsvalidation.
    
    Throws:
    
    PropertyException - if any of the Property's fails validation.
  - validation
```
List<PropertyValidationVO> validation()
```
    Validates all the Property's in the collection, stores the result in a java.util.List of PropertyValidationVO. The purpose is for the client to have a list to show in any user interface the state of properties.
    
    Returns:
    
    a list of PropertyValidationVO
    
    See Also:
    
    PropertyValidationVO
  - getPropertyByName
```
Property<?> getPropertyByName(String propertyName)
```
    Get a Property by name.
    
    Parameters:
    
    propertyName - the name of the property
    
    Returns:
    
    the Property if found, otherwise null.
  - getLogger
```
org.apache.commons.logging.Log getLogger()
```
    The org.apache.commons.logging.Log used.
    
    Returns:
    
    the logger
  - getIterator
```
Iterator<Property<?>> getIterator()
```
    Property Iterator.
    
    Returns:
    
    an iterator for all the Property's in the collection.
    
    See Also:
    
    Iterator
  - getList
```
List<Property<?>> getList()
```
    Property list sorted by name, as a Collections.unmodifiableList. Remember to sort before turning it in to a unmodifiableList list.
    
    Returns:
    
    an unmodifiableList list
    
    See Also:
    
    Collections.unmodifiableList(List)
  - getIo
```
PropertyIO getIo()
```
    The PropertyIO.
    
    Returns:
    
    the PropertyIO which the Property's has been initialized with.
    
    See Also:
    
    PropertyIO
  - getPropertyValidationHandler
```
PropertyValidationHandler getPropertyValidationHandler()
```
    When a property collection validates all the properties it contains, then this handler defines what happens in case the a property is valid or invalid.
    
    Returns:
    
    an implementation of PropertyValidationHandler of none is defined than LoggingPropertyValidationHandler is used.
    
    See Also:
    
    PropertyValidationHandler, LoggingPropertyValidationHandler
  - setPropertyValidationHandler
```
void setPropertyValidationHandler(PropertyValidationHandler propertyValidationHandler)
```
    Here you can set your PropertyValidationHandler instance. Instead of setting your PropertyValidationHandler in the constructor, you can set this in the "preValidation() method.
    
    Parameters:
    
    propertyValidationHandler - your instance of a PropertyValidationHandler.
    
    See Also:
    
    PropertyValidationHandler
  - postValidation
```
void postValidation()
             throws PropertyException
```
    After the PropertyCollection has validation the PropertyIO and all the Properties, it calls this method.
    This is implemented empty in all the framework implementations, but can be overrride in the your on instance of a PropertyCollection.
    This is use to make cross validation of Properties. If Property A is defined, than Property B, C and D must also be defined.
```
 public class MyPropertiesDemo extends PropertyStaticCollection implements MyProperties {
      public MyPropertiesDemo(FilePropertyIO io)  {
          super(io);          
                }

      public void postValidation() throws PropertyException {
        ActivationValidator activator = new ActivationValidator();
          activator.given(MyProperties.PORT_NUMBER.getTypedValue()==443,MyProperties.A_SSL_CONFIG);
          activator.given(MyProperties.MY_STRING,MyProperties.MY_NUMBER_A,MyProperties.MY_NUMBER_B,MyProperties.MY_NUMBER_C,MyProperties.MY_NUMBER_D);
      }
      
        }
 
```
    It throws an exception
    Throws:
    
    PropertyException
  - preValidation
```
void preValidation()
```
    This method is called before any validation of PropertyIO and Properties is performed, this is where you typically can setup global configurations.
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener listener)
                        throws NullPointerException
```
    Adds a PropertyChangeListener to all registrered Property's in the PropertyCollection.
    The collection has to be proper initialized before this method can be called.
    
    Parameters:
    
    listener - the listener to be added to all Property's.
    
    Throws:
    
    NullPointerException - if listener was null or the PropertyIO of the collection is null.
    
    Since:
    
    1.6
    
    See Also:
    
    Property.addPropertyChangeListener(PropertyChangeListener), LoggingPropertyValidationHandler
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener listener)
                           throws NullPointerException
```
    Removes a PropertyChangeListener from all registered Property's in the collection.
    The collection has to be proper initialized before this method can be called.
    
    Parameters:
    
    listener - the listener to be removed.
    
    Throws:
    
    NullPointerException - if listener was null or the PropertyIO of the collection is null.
    
    Since:
    
    1.6
    
    See Also:
    
    Property.removePropertyChangeListener(PropertyChangeListener)
  - removeAllPropertyChangeListeners
```
void removeAllPropertyChangeListeners()
```
    Remove all PropertyChangeListener's from the Property's in the Collection.

Interface PropertyCollection

Field Summary

Method Summary

Field Detail

PROPERTY_REGISTRY_NO_TIMEOUT

PROPERTY_REGISTRY_DO_NOT_REGISTER

Method Detail

getName

getRegistryTimeout

reload

size

validate

validation

getPropertyByName

getLogger

getIterator

getList

getIo

getPropertyValidationHandler

setPropertyValidationHandler

postValidation

preValidation

addPropertyChangeListener

removePropertyChangeListener

removeAllPropertyChangeListeners