| java.lang.Object
 org.w3c.tools.resources.upgrade.Attribute
All known Subclasses: org.w3c.tools.resources.upgrade.ClassAttribute, org.w3c.tools.resources.upgrade.IntegerAttribute, org.w3c.tools.resources.upgrade.FrameArrayAttribute, org.w3c.tools.resources.upgrade.IntegerArrayAttribute, org.w3c.tools.resources.upgrade.StringAttribute, org.w3c.tools.resources.upgrade.LongAttribute, org.w3c.tools.resources.upgrade.SegmentArrayAttribute, org.w3c.tools.resources.upgrade.BooleanAttribute, org.w3c.tools.resources.upgrade.FileAttribute, org.w3c.tools.resources.upgrade.DoubleAttribute, org.w3c.tools.resources.upgrade.MimeTypeAttribute, org.w3c.tools.resources.upgrade.ObjectAttribute, org.w3c.tools.resources.upgrade.PropertiesAttribute, org.w3c.tools.resources.upgrade.IPTemplatesAttribute, org.w3c.tools.resources.upgrade.StringArrayAttribute,
| Attribute | | abstract public class Attribute implements Serializable(Code) | | Instances of this class describe an attribute of a resource.
|
| Field Summary | |
| final public static int | COMPUTED
Flags value - This attribute is computed from the resource state. | | final public static int | DONTSAVE
Flag value - This attribute shouldn't be saved. | | final public static int | EDITABLE
Flag value - This attribute is editable. | | final public static int | MANDATORY
Flag value - This attribute is mandatory. | | protected int | flags
The associated flags (see the predefined flags). | | protected String | name
The attribute name. | | protected String | type
The attribute's value type, as the name of its class. |
| Constructor Summary | |
| public | Attribute(String name, Object def, Integer flags)
Private constructore to create a new resource attribute description. |
| Method Summary | |
| public boolean | checkFlag(int tst)
Check some flag on this attribute description. | | abstract public 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.
Parameters:
store - The array to store the value to if succeed.
Parameters:
idx - The location in the above array. | | public Object | getDefault()
Get this attribute default value. | | public String | getName()
Get this attribute name. | | abstract public 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. | | public String | getType()
Get this attribute type. | | abstract public void | pickle(DataOutputStream out, Object obj)
Pickle an attribute of this type to the given stream. | | public String | stringify(Object value)
Stringify a value of this kind. | | abstract public Object | unpickle(DataInputStream in)
Unpickle an attribute of this type from the given stream.
This method is used to restore a pickled attribute value from the given
stream. |
| COMPUTED | | final public static int COMPUTED(Code) | | Flags value - This attribute is computed from the resource state.
|
| DONTSAVE | | final public static int DONTSAVE(Code) | | Flag value - This attribute shouldn't be saved.
|
| EDITABLE | | final public static int EDITABLE(Code) | | Flag value - This attribute is editable.
|
| MANDATORY | | final public static int MANDATORY(Code) | | Flag value - This attribute is mandatory.
|
| flags | | protected int flags(Code) | | The associated flags (see the predefined flags).
|
| type | | protected String type(Code) | | The attribute's value type, as the name of its class.
|
| Attribute | | public Attribute(String name, Object def, Integer flags)(Code) | | Private constructore to create a new resource attribute description.
Parameters:
name - The name of the attribute.
Parameters:
type - Its type (as a Java class).
Parameters:
def - Its default value.
Parameters:
flags - Its associated flags. |
| checkFlag | | public boolean checkFlag(int tst)(Code) | | Check some flag on this attribute description.
|
| checkValue | | abstract public boolean checkValue(Object value)(Code) | | Is the provided object a suitable value for this attribute ?
If so, store it into the given store.
Parameters:
value - The value to check.
Parameters:
store - The array to store the value to if succeed.
Parameters:
idx - The location in the above array. A boolean true if this object can be usedas a value for this attribute.
exception:
IllegalAttributeAccess - If the provided value doesn't matchthe expected type. |
| getDefault | | public Object getDefault()(Code) | | Get this attribute default value.
A default value for this attribute (may benull). |
| getName | | public String getName()(Code) | | Get this attribute name.
A String giving the attribute name. |
| getPickleLength | | abstract public int getPickleLength(Object value)(Code) | | 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. The number of bytes needed to pickle that value. |
| getType | | public String getType()(Code) | | Get this attribute type.
|
| pickle | | abstract public void pickle(DataOutputStream out, Object obj) throws IOException(Code) | | 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.
Parameters:
obj - The object to pickle.
exception:
IOException - If some IO error occured while dump theattribute. |
| stringify | | public String stringify(Object value)(Code) | | Stringify a value of this kind.
Parameters:
obj - The value to stringify. |
| unpickle | | abstract public Object unpickle(DataInputStream in) throws IOException(Code) | | 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. The object value.
exception:
IOException - If some IOError occured while reading the stream. |
|
|