net.dpml.lang
Class Classpath

java.lang.Object
  extended bynet.dpml.lang.AbstractDirective
      extended bynet.dpml.lang.Classpath
All Implemented Interfaces:
Serializable

public final class Classpath
extends AbstractDirective

A Plugin class contains immutable data about a plugin based on a descriptor resolved from a 'plugin' artifact.

Version:
1.0.0
Author:
The Digital Product Meta Library
See Also:
Serialized Form

Constructor Summary
Classpath()
          Creation of a empty classpath definition.
Classpath(Classpath base, Classpath extension)
          Creation of a new classpath definition.
Classpath(Classpath base, URI[] systemUris, URI[] publicUris, URI[] protectedUris, URI[] privateUris)
          Creation of a new classpath definition.
Classpath(URI[] systemUris, URI[] publicUris, URI[] protectedUris, URI[] privateUris)
          Creation of a new classpath definition.
 
Method Summary
 boolean equals(Object other)
          Compare this object with another for equality.
 Classpath getBaseClasspath()
          Return the base classpath.
 URI[] getDependencies(Category category)
          Return the classloader dependencies relative to a supplied classloader category.
 int hashCode()
          Return the hashcode for the plugin definition.
 String toString()
          Return the classpath as a string.
 
Methods inherited from class net.dpml.lang.AbstractDirective
equals, hashArray, hashValue
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Classpath

public Classpath()
Creation of a empty classpath definition.


Classpath

public Classpath(Classpath base,
                 Classpath extension)
Creation of a new classpath definition.

Parameters:
base - the base classpath from which this classpath is derived
extension - the extended classpath definition

Classpath

public Classpath(URI[] systemUris,
                 URI[] publicUris,
                 URI[] protectedUris,
                 URI[] privateUris)
Creation of a new classpath definition.

Parameters:
systemUris - an array of uris representing the system classpath extensions
publicUris - an array of uris representing the public classpath entries
protectedUris - an array of uris representing protected classpath entries
privateUris - an array of uris representing private classpath entries

Classpath

public Classpath(Classpath base,
                 URI[] systemUris,
                 URI[] publicUris,
                 URI[] protectedUris,
                 URI[] privateUris)
Creation of a new classpath definition.

Parameters:
base - super classpath (may be null)
systemUris - an array of uris representing the system classpath extensions
publicUris - an array of uris representing the public classpath entries
protectedUris - an array of uris representing protected classpath entries
privateUris - an array of uris representing private classpath entries
Method Detail

getBaseClasspath

public Classpath getBaseClasspath()
Return the base classpath.

Returns:
the base classpath that this classpath extends (possibly null)

getDependencies

public URI[] getDependencies(Category category)
Return the classloader dependencies relative to a supplied classloader category.

Parameters:
category - the classloader category
Returns:
an array of uris defining the classloader classpath for the supplied category

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 else FALSE

hashCode

public int hashCode()
Return the hashcode for the plugin definition.

Overrides:
hashCode in class AbstractDirective
Returns:
the hash code

toString

public String toString()
Return the classpath as a string.

Returns:
the string value