All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class w3c.tools.store.Attribute 

java.lang.Object
   |
   +----w3c.tools.store.Attribute
public abstract class Attribute
extends Object
implements Serializable
Instances of this class describe an attribute of a resource.

Variable Index

o COMPUTED
Flags value - This attribute is computed from the resource state.
o DONTSAVE
Flag value - This attribute shouldn't be saved.
o EDITABLE
Flag value - This attribute is editable.
o flags
The associated flags (see the predefined flags).
o MANDATORY
Flag value - This attribute is mandatory.
o name
The attribute name.
o type
The attribute's value type, as the name of its class.

Constructor Index

o Attribute(String, Object, int)
Private constructore to create a new resource attribute description.

Method Index

o checkFlag(int)
Check some flag on this attribute description.
o checkValue(Object)
Is the provided object a suitable value for this attribute ? If so, store it into the given store.
o getDefault()
Get this attribute default value.
o getName()
Get this attribute name.
o getPickleLength(Object)
Get number of bytes needed to pickle that attribute.
o getType()
Get this attribute type.
o pickle(DataOutputStream, Object)
Pickle an attribute of this type to the given stream.
o stringify(Object)
Stringify a value of this kind.
o unpickle(DataInputStream)
Unpickle an attribute of this type from the given stream.

Variables

o COMPUTED 
 public static final int COMPUTED
Flags value - This attribute is computed from the resource state.

o EDITABLE 
 public static final int EDITABLE
Flag value - This attribute is editable.

o MANDATORY 
 public static final int MANDATORY
Flag value - This attribute is mandatory.

o DONTSAVE 
 public static final int DONTSAVE
Flag value - This attribute shouldn't be saved.

o name 
 protected String name
The attribute name.

o type 
 protected String type
The attribute's value type, as the name of its class.

o flags 
 protected int flags
The associated flags (see the predefined flags).

Constructors

o Attribute 
 public Attribute(String name,
                  Object def,
                  int flags)
Private constructore to create a new resource attribute description.

Parameters:
name - The name of the attribute.
type - Its type (as a Java class).
def - Its default value.
flags - Its associated flags.

Methods

o getName 
 public String getName()
Get this attribute name.

Returns:
A String giving the attribute name.
o getType 
 public String getType()
Get this attribute type.

o checkFlag 
 public boolean checkFlag(int tst)
Check some flag on this attribute description.

o getDefault 
 public Object getDefault()
Get this attribute default value.

Returns:
A default value for this attribute (may be null).
o stringify 
 public String stringify(Object value)
Stringify a value of this kind.

Parameters:
obj - The value to stringify.
o checkValue 
 public abstract boolean checkValue(Object value)
Is the provided object a suitable value for this attribute ? If so, store it into the given store.

Parameters:
value - The value to check.
store - The array to store the value to if succeed.
idx - The location in the above array.
Returns:
A boolean true if this object can be used as a value for this attribute.
Throws: IllegalAttributeAccess
If the provided value doesn't match the expected type.
o getPickleLength 
 public abstract int getPickleLength(Object value)
Get number of bytes needed to pickle that attribute. This method is always called before pickling an attribute, to get the length of that attribute value, and record it before saving the actual bytes. This allows, for example, to skip attribute whose definition was removed from a class.

In an ASCII format, this plays a role similar to emitting a newline.

Parameters:
value - The value that is about to be pickled.
Returns:
The number of bytes needed to pickle that value.
o pickle 
 public abstract void pickle(DataOutputStream out,
                             Object obj) throws IOException
Pickle an attribute of this type to the given stream. This method is used to make attribute values persistent, the pickle method should dump the provided value in whatever format, provided its unpickle method is able to restore it.

Parameters:
out - The DataOutputStream to dump the object to.
obj - The object to pickle.
Throws: IOException
If some IO error occured while dump the attribute.
o unpickle 
 public abstract Object unpickle(DataInputStream in) throws IOException
Unpickle an attribute of this type from the given stream. This method is used to restore a pickled attribute value from the given stream. It should read in the format it used at pickle time, and consume the same number of bytes from the stream.

Parameters:
in - The DataInputStream to read from.
Returns:
The object value.
Throws: IOException
If some IOError occured while reading the stream. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index