org.opencms.module

Class CmsModuleDependency

java.lang.Object

org.opencms.module.CmsModuleDependency

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<java.lang.Object>

public class CmsModuleDependency
extends java.lang.Object
implements java.lang.Comparable<java.lang.Object>, java.io.Serializable

Describes an OpenCms module dependency.

Module dependencies are checked if a module is imported or deleted. If a module A requires certain resources (like Java classes) from another module B, a should be made dependend on B.

Since:

6.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CmsModuleDependency() Generates a new, empty module dependency.
CmsModuleDependency(java.lang.String moduleName, CmsModuleVersion minVersion) Generates a new module dependency.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(java.lang.Object obj)
boolean	dependesOn(CmsModuleDependency other) Checks if this module depedency depends on another given module dependency.
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of the module dependency.
CmsModuleVersion	getVersion() Returns the minimum version of the dependency.
int	hashCode()
void	setName(java.lang.String value) Sets the name of a module dependency.
void	setVersion(CmsModuleVersion value) Sets the version of a module dependency.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsModuleDependency

public CmsModuleDependency()

Generates a new, empty module dependency.

CmsModuleDependency

public CmsModuleDependency(java.lang.String moduleName,
                           CmsModuleVersion minVersion)

Generates a new module dependency.

Parameters:

moduleName - the name of the module dependency

minVersion - the minimum version of the dependency

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

compareTo

public int compareTo(java.lang.Object obj)

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Object>

See Also:

Comparable.compareTo(java.lang.Object)

dependesOn

public boolean dependesOn(CmsModuleDependency other)

Checks if this module depedency depends on another given module dependency.

Parameters:

other - the other dependency to check against

Returns:

true if this module depedency depends on the given module dependency

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getName

public java.lang.String getName()

Returns the name of the module dependency.

Returns:

the name of the module dependency

getVersion

public CmsModuleVersion getVersion()

Returns the minimum version of the dependency.

Returns:

the minimum version of the dependency

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

setName

public void setName(java.lang.String value)

Sets the name of a module dependency.

Parameters:

value - the name of a module dependency

setVersion

public void setVersion(CmsModuleVersion value)

Sets the version of a module dependency.

Parameters:

value - the version of a module dependency

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()