    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class w3c.jigsaw.resources.Attribute

    java.lang.Object
       |
       +----w3c.jigsaw.resources.Attribute

public class Attribute
extends Object

Instances of this class describe an attribute of a resource.

##

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

##

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

##

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

##

COMPUTED

      public final static int COMPUTED

  Flags value - This attribute is computed from the resource state.

EDITABLE

      public final static int EDITABLE

  Flag value - This attribute is editable.

MANDATORY

      public final static int MANDATORY

  Flag value - This attribute is mandatory.

DONTSAVE

      public final static int DONTSAVE

  Flag value - This attribute shouldn't be saved.

name

      protected String name

  The attribute name.

type

      protected String type

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

defvalue

      protected Object defvalue

  The attribute's default value.

flags

      protected int flags

  The associated flags (see the predefined flags).

##

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.

##

getName

      public String getName()

  Get this attribute name.
  Returns:
    A String giving the attribute name.

getType

      public String getType()

  Get this attribute type.

checkFlag

      public boolean checkFlag(int tst)

  Check some flag on this attribute description.

getDefault

      public Object getDefault()

  Get this attribute default value.
  Returns:
    A default value for this attribute (may be null).

stringify

      public String stringify(Object value)

  Stringify a value of this kind.
  Parameters:
    obj - The value to stringify.

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.

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.

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