net.dpml.transit.info
Class CacheDirective

java.lang.Object
  net.dpml.lang.AbstractDirective
      net.dpml.transit.info.CacheDirective

All Implemented Interfaces:

Serializable

public class CacheDirective

extends AbstractDirective

Description of the Transit cache configuration.

Version:

1.0.2

Author:

Digital Product Meta Library

See Also:

Serialized Form

Field Summary

static String	CACHE_LAYOUT Default layout strategy key.
static String	CACHE_PATH Default cache path.
static HostDirective[]	EMPTY_HOSTS Empty resource host array.
static LayoutDirective[]	EMPTY_LAYOUTS Empty layout array.
static String	LOCAL_LAYOUT Default layout strategy key.
static String	LOCAL_PATH Default system local repository path.

Constructor Summary

CacheDirective()
Create a new CacheDirective.

CacheDirective(String cache, String cacheLayout, String local, String localLayout, LayoutDirective[] layouts, HostDirective[] hosts)
Create a new CacheDirective.

Method Summary

boolean	equals(Object other) Test if the supplied object is equal to this object.
String	getCache() Return the cache path.
String	getCacheLayout() Return the cache layout id.
HostDirective[]	getHostDirectives() Return the supplimentary layout plugin configurations.
LayoutDirective[]	getLayoutDirectives() Return the supplimentary layout plugin configurations.
String	getLocal() Return the local repository path.
String	getLocalLayout() Return the local system repository layout id.
int	hashCode() Compute the instance hashcode value.

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

Field Detail

CACHE_PATH

public static final String CACHE_PATH

Default cache path.

See Also:

Constant Field Values

LOCAL_PATH

public static final String LOCAL_PATH

Default system local repository path.

See Also:

Constant Field Values

CACHE_LAYOUT

public static final String CACHE_LAYOUT

Default layout strategy key.

See Also:

Constant Field Values

LOCAL_LAYOUT

public static final String LOCAL_LAYOUT

Default layout strategy key.

See Also:

Constant Field Values

EMPTY_LAYOUTS

public static final LayoutDirective[] EMPTY_LAYOUTS

Empty layout array.

EMPTY_HOSTS

public static final HostDirective[] EMPTY_HOSTS

Empty resource host array.

Constructor Detail

CacheDirective

public CacheDirective()

Create a new CacheDirective.

CacheDirective

public CacheDirective(String cache,
                      String cacheLayout,
                      String local,
                      String localLayout,
                      LayoutDirective[] layouts,
                      HostDirective[] hosts)
               throws NullPointerException

Create a new CacheDirective.

Parameters:

cache - the cache directory path

cacheLayout - the cache layout strategy

local - the local repository path

localLayout - the local repository layout strategy

layouts - an array of extended layout descriptors

hosts - an array of supplimentary host descriptors

Throws:

NullPointerException - if the cache, local, or layout argument is null

Method Detail

getCache

public String getCache()

Return the cache path.

Returns:

the cache path

getCacheLayout

public String getCacheLayout()

Return the cache layout id.

Returns:

the cache layout identifier

getLocal

public String getLocal()

Return the local repository path.

Returns:

the local repository path

getLocalLayout

public String getLocalLayout()

Return the local system repository layout id.

Returns:

the system layout identifier

getLayoutDirectives

public LayoutDirective[] getLayoutDirectives()

Return the supplimentary layout plugin configurations.

Returns:

the layout directives

getHostDirectives

public HostDirective[] getHostDirectives()

Return the supplimentary layout plugin configurations.

Returns:

the host directives

equals

public boolean equals(Object other)

Test if the supplied object is equal to this object.

Overrides:

equals in class AbstractDirective

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 AbstractDirective

Returns:

the hashcode