All Packages  This Package  Class Hierarchy  Class Search  Index

Summary

public interface  PropertyOwner
{
          // Fields 2
     public static final String ANY_VALUE_STRING;
     public static final Boolean[] BOOLEAN_ARRAY;

          // Methods 6
     public abstract void clearProperties();
     public abstract Object getPossibleValuesForProperty(String) throws InvalidOptionException;
     public abstract Object getProperty(String);
     public abstract String getPropertyDescription(String) throws InvalidOptionException;
     public abstract Enumeration getPropertyNames();
     public abstract void setProperty(String, Object) throws InvalidOptionException;
}

Useful interface to check for consistancy of implementation of a generalised Property holding facility on any given class.

Cross Reference

Implemented By:

JimiReader, JimiWriter

   public static final String ANY_VALUE_STRING

   public static final Boolean[] BOOLEAN_ARRAY

Keeps memory use down for boolean options

Methods

· getProperty

Summary  |  Top

   public abstract Object getProperty(String key) 

Parameter	Description
key	the id of the property to set a value for
val	the value to set the property to

Returns:

the previous value of the property being set

   public abstract void setProperty(String key, 
                                    Object val)  throws InvalidOptionException

Matching getProperty() method for the setProperty() method.

Parameter	Description
key	which property to retrieve the value for

Returns:

the value in this property list with the specified key value

Throws: InvalidOptionException

thrown when an Encoder or Decoder finds any problems with the key value pair that is set.

   public abstract Object getPossibleValuesForProperty(String name)  throws InvalidOptionException

What possible values may this property take on. A null return value indicates any value. A java.lang.String matching ANY_VALUE_STRING indicates that the value may be any string. Otherwise it will return an array of valid values.

Parameter	Description
key	Property to get possible values for

Returns:

Either

• null
• ANY_VALUE_STRING
• Object[]The possible values for this property. (Usually a String[])

Throws: InvalidOptionException

thrown if the parameter name is not a valid option property for this implementation of PropertyOwner.

See Also: ANY_VALUE_STRING, setProperty

   public abstract String getPropertyDescription(String name)  throws InvalidOptionException

A brief description of the purpose of this property.

Parameter	Description
name	Property to be described

Returns:

The description

Throws: InvalidOptionException

thrown if the parameter name is not a valid option property for this implementation of PropertyOwner.

See Also: getPossibleValuesForProperty

   public abstract Enumeration getPropertyNames() 

The names of the properties that may be set.

See Also: getPossibleValuesForProperty

   public abstract void clearProperties() 

Clear all values and keys

All Packages  This Package  Class Hierarchy  Class Search  Index