net.dpml.transit.info
Class LayoutDirective

java.lang.Object
  net.dpml.lang.AbstractDirective
      net.dpml.transit.info.CodeBaseDirective
          net.dpml.transit.info.LayoutDirective

All Implemented Interfaces:

Serializable

public class LayoutDirective

extends CodeBaseDirective

The CodeBaseDirective is immutable datastructure used to describe a codebase.

Version:

1.0.1

Author:

Digital Product Meta Library

See Also:

Serialized Form

Constructor Summary

LayoutDirective(String id, String title, URI codebase, ValueDirective[] parameters)
Creation of a new codebase descriptor.

Method Summary

boolean	equals(Object other) Test if the supplied object is equal to this object.
String	getID() Return the unique content handler datatype identifier.
String	getTitle() Return the content handler title.
int	hashCode() Compute the instance hashcode value.

Methods inherited from class net.dpml.transit.info.CodeBaseDirective

getCodeBaseURI, getCodeBaseURISpec, getValueDirectives

Methods inherited from class net.dpml.lang.AbstractDirective

equals, hashArray, hashValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutDirective

public LayoutDirective(String id,
                       String title,
                       URI codebase,
                       ValueDirective[] parameters)
                throws NullPointerException

Creation of a new codebase descriptor.

Parameters:

id - the datatype identifier

title - the handler title

codebase - the codebase uri

parameters - an array of plugin parameter descriptors

Throws:

NullPointerException - if the id is null

Method Detail

getID

public String getID()

Return the unique content handler datatype identifier.

Returns:

the handler id

getTitle

public String getTitle()

Return the content handler title.

Returns:

the title

equals

public boolean equals(Object other)

Test if the supplied object is equal to this object.

Overrides:

equals in class CodeBaseDirective

Parameters:

other - the object to evaluate

Returns:

true if this object is equal to the supplied object

hashCode

public int hashCode()

Compute the instance hashcode value.

Overrides:

hashCode in class CodeBaseDirective

Returns:

the hashcode