net.dpml.library.info
Class ModuleDirective

java.lang.Object
  net.dpml.library.info.AbstractDirective
      net.dpml.library.info.ResourceDirective
          net.dpml.library.info.ModuleDirective

All Implemented Interfaces:

Serializable

public final class ModuleDirective

extends ResourceDirective

The ModuleDirective class describes a module data-structure.

Version:

1.0.0

Author:

The Digital Product Meta Library

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class net.dpml.library.info.ResourceDirective

ResourceDirective.Classifier

Field Summary

Fields inherited from class net.dpml.library.info.ResourceDirective

ANONYMOUS, EXTERNAL, LOCAL

Constructor Summary

ModuleDirective(String name, ResourceDirective resource)
Creation of a new module directive supporting the establishment of an anonymous resource.

ModuleDirective(String name, String version, ResourceDirective.Classifier classifier, String basedir, InfoDirective info, DataDirective[] data, DependencyDirective[] dependencies, ResourceDirective[] resources, Properties properties, FilterDirective[] filters)
Creation of a new module directive.

Method Summary

static ModuleDirective	createModuleDirective(String name, String version, ResourceDirective.Classifier classifier, String basedir, InfoDirective info, DataDirective[] data, DependencyDirective[] dependencies, Properties properties, FilterDirective[] filters, ResourceDirective[] resources) Creation of a new module directive.
boolean	equals(Object other) Compare this object with another for equality.
ResourceDirective[]	getResourceDirectives() Return an array of resource directives representing the resources within the module.
int	hashCode() Compute the hash value.

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

createAnonymousResource, createResourceDirective, getBasedir, getClassifier, getDataDirectives, getDependencyDirective, getDependencyDirectives, getFilterDirectives, getInfoDirective, getName, getScheme, getTypeDirective, getTypeDirectives, getVersion, isAnonymous, isLocal

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, toString, wait, wait, wait

Constructor Detail

ModuleDirective

public ModuleDirective(String name,
                       ResourceDirective resource)

Creation of a new module directive supporting the establishment of an anonymous resource.

Parameters:

name - the module name

resource - resource contained within the module

ModuleDirective

public ModuleDirective(String name,
                       String version,
                       ResourceDirective.Classifier classifier,
                       String basedir,
                       InfoDirective info,
                       DataDirective[] data,
                       DependencyDirective[] dependencies,
                       ResourceDirective[] resources,
                       Properties properties,
                       FilterDirective[] filters)

Creation of a new module directive.

Parameters:

name - the resource name

version - the resource version

classifier - LOCAL or EXTERNAL classifier

basedir - the project basedir

info - info descriptor

data - datatypes produced by the resource

dependencies - resource dependencies

resources - resource included within the module

properties - suppliementary properties

filters - project filters

Method Detail

createModuleDirective

public static ModuleDirective createModuleDirective(String name,
                                                    String version,
                                                    ResourceDirective.Classifier classifier,
                                                    String basedir,
                                                    InfoDirective info,
                                                    DataDirective[] data,
                                                    DependencyDirective[] dependencies,
                                                    Properties properties,
                                                    FilterDirective[] filters,
                                                    ResourceDirective[] resources)

Creation of a new module directive. If the resource name if composite then the resource directive will be a module directive instance that either encloses the resource or enclosed a resource containing the resource.

Parameters:

name - the resource name

version - the resource version

classifier - LOCAL or EXTERNAL classifier

basedir - the project basedir

info - info descriptor

data - datatypes produced by the resource

dependencies - resource dependencies

properties - suppliementary properties

filters - project filters

resources - subsidary resources

Returns:

the immediate enclosing resource

getResourceDirectives

public ResourceDirective[] getResourceDirectives()

Return an array of resource directives representing the resources within the module.

Returns:

the nested resource directives

equals

public boolean equals(Object other)

Compare this object with another for equality.

Overrides:

equals in class ResourceDirective

Parameters:

other - the other object

Returns:

true if equal

hashCode

public int hashCode()

Compute the hash value.

Overrides:

hashCode in class ResourceDirective

Returns:

the hashcode value