oracle.javatools.util
Class DynamicPropertySetImpl

java.lang.Object
  oracle.javatools.util.DynamicPropertySetImpl

All Implemented Interfaces:

Copyable, DynamicPropertySet

public final class DynamicPropertySetImpl
extends java.lang.Object
implements DynamicPropertySet

Implementation of the DynamicPropertySet interface. This class uses a HashMap to manage the property-value pairs. The class is also final.

Constructor Summary

DynamicPropertySetImpl()
Default Constructor;

DynamicPropertySetImpl(DynamicPropertySetImpl propertySet)
Copy constructor.

Method Summary

void	clear() Clears property-value pairs map.
java.lang.Object	copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy.
protected void	copyToImpl(DynamicPropertySetImpl copy) Design pattern for supporting strongly typed copying.
boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(DynamicPropertySetImpl other) This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object).
java.util.Map	getProperties() Retrieves a map holding the property-value pairs.
java.lang.Object	getProperty(java.lang.String key) Retrieves the value associated with a property.
java.lang.Object	getProperty(java.lang.String key, java.lang.Object defaultValue) Retrieves the value associated with a property.
void	setProperties(java.util.Map properties) Sets the map holding the property-value pairs.
void	setProperty(java.lang.String key, java.lang.Object value) Sets the value for a property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicPropertySetImpl

public DynamicPropertySetImpl()

Default Constructor;

DynamicPropertySetImpl

public DynamicPropertySetImpl(DynamicPropertySetImpl propertySet)

Copy constructor.

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String key,
                                    java.lang.Object defaultValue)

Description copied from interface: DynamicPropertySet

Retrieves the value associated with a property. If no value exists for the requested property, the specified default value is returned.

Specified by:

getProperty in interface DynamicPropertySet

Parameters:

key - the property key for which a value is desired.

defaultValue - the value to return if no value currently exists.

Returns:

the value of the requested property, or the default value if the property does not exist.

getProperty

public java.lang.Object getProperty(java.lang.String key)

Description copied from interface: DynamicPropertySet

Retrieves the value associated with a property.

Specified by:

getProperty in interface DynamicPropertySet

Parameters:

key - the property key for which a value is desired. exists.

Returns:

the value of the requested property, or a null value if the property does not exist or is not set.

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)

Description copied from interface: DynamicPropertySet

Sets the value for a property. Setting a value to null removes that property.

Specified by:

setProperty in interface DynamicPropertySet

Parameters:

key - the property key to set

value - the value to set

getProperties

public java.util.Map getProperties()

Description copied from interface: DynamicPropertySet

Retrieves a map holding the property-value pairs.

Specified by:

getProperties in interface DynamicPropertySet

setProperties

public void setProperties(java.util.Map properties)

Description copied from interface: DynamicPropertySet

Sets the map holding the property-value pairs.

Specified by:

setProperties in interface DynamicPropertySet

clear

public void clear()

Clears property-value pairs map.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equalsImpl

protected final boolean equalsImpl(DynamicPropertySetImpl other)

This is a helper method for equals(Object) that can also be used by subclasses that implement equals(Object). It assumes that the argument is not null.

copyTo

public java.lang.Object copyTo(java.lang.Object target)

Description copied from interface: Copyable

Copies the internal state of this object to the specified copy. If copy is null, then this method should create a new instance of this class and proceed to copy the internal state to the newly created object. Generally, only the persistent state of the object should be copied, but whether or not it is appropriate to copy transient properties is at the discretion of the individual implementor.

Regardless of whether the copy occurs to an existing object or to a newly created object, the return value is object to which this object's state was copied.

There is a standard implementation pattern for the copyTo method that helps avoid problems that arise when a Copyable object is subclassed. The pattern is:

    public Object copyTo( Object target )
    {
      final <this_class> copy =
        target != null ? (<this_class>) target : new <this_class>();
      copyToImpl( copy );
      return copy;
    }

    protected final void copyToImpl( <this_class> copy )
    {
      super.copyToImpl( copy );  //  if necessary
      //  put code here for copying the properties of <this_class>
    }
  

The parameter passed into the copyToImpl method is the same type of this class. The responsibility of copyToImpl is to copy the state of this class through direct access of the fields. The copyToImpl method should not use getters and setters since these may be overridden, causing the state of this class to be incompletely copied.

Specified by:

copyTo in interface Copyable

Parameters:

target - The target object to which the state of this object should be copied. If target is null, then the copyTo method will return a new instance of this class.

Returns:

The object to which the state of this object was copied. If the target was non-null, then the return value is the same as the target object that was passed in; otherwise, the return value is a new instance of this class.

copyToImpl

protected final void copyToImpl(DynamicPropertySetImpl copy)

Design pattern for supporting strongly typed copying.