All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class w3c.tools.store.PropertiesAttribute

java.lang.Object
   |
   +----w3c.tools.store.Attribute
           |
           +----w3c.tools.store.PropertiesAttribute

public class PropertiesAttribute
extends Attribute
The generic description of an PropertiesAttribute. A PropertiesAttribute instance holds a String to String mapping, it should be used only with care, since people may act on a reference to it.


Constructor Index

 o PropertiesAttribute(String, String, int)
Create a description for a generic property list attribute.

Method Index

 o checkValue(Object)
Is the given object a valid PropertiesAttribute value ?
 o getPickleLength(Object)
Get the number of bytes required to save that attribute value.
 o pickle(DataOutputStream, Object)
Pickle a property list to the given output stream.
 o unpickle(DataInputStream)
Unpickle an string from the given input stream.

Constructors

 o PropertiesAttribute
 public PropertiesAttribute(String name,
                            String def,
                            int flags)
Create a description for a generic property list attribute.

Parameters:
name - The attribute name.
def - The default value for these attributes.
flags - The associated flags.

Methods

 o checkValue
 public boolean checkValue(Object obj)
Is the given object a valid PropertiesAttribute value ?

Parameters:
obj - The object to test.
Returns:
A boolean true if value is valid.
Overrides:
checkValue in class Attribute
 o getPickleLength
 public final int getPickleLength(Object value)
Get the number of bytes required to save that attribute value.

Parameters:
The - value about to be pickled.
Returns:
The number of bytes needed to pickle that value.
Overrides:
getPickleLength in class Attribute
 o pickle
 public void pickle(DataOutputStream out,
                    Object o) throws IOException
Pickle a property list to the given output stream.

Parameters:
out - The output stream to pickle to.
obj - The object to pickle.
Throws: IOException
If some IO error occured.
Overrides:
pickle in class Attribute
 o unpickle
 public Object unpickle(DataInputStream in) throws IOException
Unpickle an string from the given input stream.

Parameters:
in - The input stream to unpickle from.
Returns:
An instance of String.
Throws: IOException
If some IO error occured.
Overrides:
unpickle in class Attribute

All Packages  Class Hierarchy  This Package  Previous  Next  Index