net.dpml.library.info
Class IncludeDirective

java.lang.Object
  net.dpml.library.info.AbstractDirective
      net.dpml.library.info.IncludeDirective

All Implemented Interfaces:

Serializable

public class IncludeDirective

extends AbstractDirective

The IncludeDirective class describes a dependency on a named resource.

Version:

1.0.0

Author:

The Digital Product Meta Library

See Also:

Serialized Form

Nested Class Summary

static class

IncludeDirective.Mode Mode of inclusion.

Field Summary

static IncludeDirective.Mode	KEY Current module scoped key mode constant.
static IncludeDirective.Mode	REF Absolute resource reference mode constant.
static IncludeDirective.Mode	URI URN resource reference mode constant.

Constructor Summary

IncludeDirective(IncludeDirective.Mode mode, Category category, String value, Properties properties)
Creation of a new include directive.

Method Summary

boolean	equals(Object other) Compare this object with another for equality.
Category	getCategory() Return the category associated with the include.
IncludeDirective.Mode	getMode() Return the include mode.
String	getValue() Return the include value.
int	hashCode() Compute the hash value.
String	toString() Return a string representation of the include.

Methods inherited from class net.dpml.library.info.AbstractDirective

equals, getProperties, getProperty, hashArray, hashValue

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final IncludeDirective.Mode KEY

Current module scoped key mode constant.

REF

public static final IncludeDirective.Mode REF

Absolute resource reference mode constant.

URI

public static final IncludeDirective.Mode URI

URN resource reference mode constant.

Constructor Detail

IncludeDirective

public IncludeDirective(IncludeDirective.Mode mode,
                        Category category,
                        String value,
                        Properties properties)

Creation of a new include directive.

Parameters:

mode - the include mode

category - the runtime category

value - the value (key or reference address depending on mode)

properties - supplimentary properties

Method Detail

getMode

public IncludeDirective.Mode getMode()

Return the include mode.

Returns:

the mode

getCategory

public Category getCategory()

Return the category associated with the include.

Returns:

the category

getValue

public String getValue()

Return the include value.

Returns:

the value

equals

public boolean equals(Object other)

Compare this object with another for equality.

Overrides:

equals in class AbstractDirective

Parameters:

other - the other object

Returns:

true if equal

hashCode

public int hashCode()

Compute the hash value.

Overrides:

hashCode in class AbstractDirective

Returns:

the hascode value

toString

public String toString()

Return a string representation of the include.

Returns:

the string value