de.smartics.properties.api.config.domain
Class DescribedProperty

java.lang.Object
  de.smartics.properties.api.config.domain.Property
      de.smartics.properties.api.config.domain.DescribedProperty

All Implemented Interfaces:

Serializable, Comparable< Property>

Direct Known Subclasses:

ValidatedProperty

public class DescribedProperty
     
     

      
      extends 
      
      Property
     
     

Extends the Property with metadata concerning the property and the configuration.

See Also:

Serialized Form

Constructor Summary

DescribedProperty(ConfigurationKey<?> configurationKey, PropertyDescriptor descriptor, Property property)
Default constructor.

DescribedProperty(DescribedProperty property)
Copy-constructor.

Method Summary

ConfigurationKey<?>	getConfigurationKey() Returns the identifier of the configuration this property is part of.
PropertyDescriptor	getDescriptor() Returns the descriptor to the property to access property metadata.
String	toString() Returns the string representation of the object.

Methods inherited from class de.smartics.properties.api.config.domain.Property

compareTo, equals, getName, getSource, getValue, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribedProperty

public DescribedProperty(ConfigurationKey<?> configurationKey,
                         PropertyDescriptor descriptor,
                         Property property)
                  throws NullPointerException

Default constructor.

Parameters:

configurationKey - the identifier of the configuration this property is part of.

descriptor - the descriptor to the property to access property metadata.

property - the referenced property to copy.

Throws:

NullPointerException - if descriptor or property is null.

DescribedProperty

public DescribedProperty(DescribedProperty property)
                  throws NullPointerException

Copy-constructor.

Parameters:

property - the property to copy.

Throws:

NullPointerException - if property is null.

Method Detail

getConfigurationKey

@CheckForNull
public final ConfigurationKey<?> getConfigurationKey()

Returns the identifier of the configuration this property is part of. The value is set to null, if the property has not been found in a configuration. With other words, the property has a default or no value.

Returns:

the identifier of the configuration this property is part of.

getDescriptor

public final PropertyDescriptor getDescriptor()

Returns the descriptor to the property to access property metadata.

Returns:

the descriptor to the property to access property metadata.

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Property

Returns:

the string representation of the object.