Top Description Fields Constructors Methods
com.sun.enterprise.module

public Class ModuleDependency

extends Object
Class Inheritance

A ModuleDependency instance holds all information necessary to identify a dependency between modules. Modules can declare their dependency on a separate module using the name, the version and whether they accept the sub module implementation to be shared. They can also specify whether or not they want to re-export the sub module public interfaces. Re-exporting means that the sub-module's public interfaces will also be published as a public interface of the enclosing module.
Author
Jerome Dochez

Field Summary

Modifier and TypeField and Description
private final String
private final boolean
private final boolean
private final String

Constructor Summary

AccessConstructor and Description
public
ModuleDependency(String
the module name
name
,
String
the module version
version
)

Create a new instance of ModuleDependency, where the sub module is idenfied by its name and version.

public
ModuleDependency(String
the module name
name
,
String
the module version
version
,
boolean
true if the containing module accept a shared copy
shared
,
boolean reexport)

Create a new instance of ModuleDependency, where the sub module is idenfied by its name and version and wheter the containing module requires a private copy or not

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the module name
getName
()

Returns the module name

public String

Returns:

the module version
getVersion
()

Returns the module version

public boolean

Returns:

true if reexporting the sub module public interface
isReexporting
()

Returns true if the containing module is reexporting the public interfaces of the sub module

public boolean

Returns:

true if shared implementation is acceptable
isShared
()

Returns true if the containing module accept a shared implementation of the sub module

public String

Returns:

a printable string about myself
toString
()

Overrides java.lang.Object.toString.

Returns a string representation

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name
reexportback to summary
private final boolean reexport
sharedback to summary
private final boolean shared
versionback to summary
private final String version

Constructor Detail

ModuleDependencyback to summary
public ModuleDependency(String name, String version)

Create a new instance of ModuleDependency, where the sub module is idenfied by its name and version. The sub module implementation should be shared among users of that module

Parameters
name:String

the module name

version:String

the module version

ModuleDependencyback to summary
public ModuleDependency(String name, String version, boolean shared, boolean reexport)

Create a new instance of ModuleDependency, where the sub module is idenfied by its name and version and wheter the containing module requires a private copy or not

Parameters
name:String

the module name

version:String

the module version

shared:boolean

true if the containing module accept a shared copy

Method Detail

getNameback to summary
public String getName()

Returns the module name

Returns:String

the module name

getVersionback to summary
public String getVersion()

Returns the module version

Returns:String

the module version

isReexportingback to summary
public boolean isReexporting()

Returns true if the containing module is reexporting the public interfaces of the sub module

Returns:boolean

true if reexporting the sub module public interface

isSharedback to summary
public boolean isShared()

Returns true if the containing module accept a shared implementation of the sub module

Returns:boolean

true if shared implementation is acceptable

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a string representation

Returns:String

a printable string about myself