Package lumis.portal.deployment.process

Class ModuleObject

java.lang.Object

lumis.portal.deployment.process.ModuleObject

All Implemented Interfaces:

java.io.Serializable, IDeployObject

public class ModuleObject
extends java.lang.Object

Module object.

Since:

8.1.0

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface lumis.portal.deployment.process.IDeployObject

IDeployObject.ObjectType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModuleObject()

Method Summary

Modifier and Type	Method	Description
boolean	accumulateChecksum()	Indicates whether the checksum of this object should accumulate the subtree.
IDeployObject	find(java.lang.String id, IDeployObject.ObjectType objectType, java.util.EnumSet<IDeployObject.ObjectType> allowedInnerObjects)	Finds the object with the given identifier of the given type in subtree.
java.util.Collection<IDeployObject>	find(IDeployObject.ObjectType type, java.util.EnumSet<IDeployObject.ObjectType> allowedInnerObjects)	Find all objects of the given type in subtree, but discards subtrees when their root type is not contained in the given set.
java.lang.String	getChecksum()	Returns the checksum of this object.
<T extends lumis.portal.deployment.process.IChecksumListener> T	getChecksumListener()	Returns the checksum listener of this object.
java.util.Map<java.lang.String,IDeployObject>	getFiles()	Returns a map with all files present in this module.
java.lang.String	getId()	Returns the identifier of this object.
java.util.Collection<IDeployObject>	getInnerObjects()	Returns a collection with the inner objects.
IDeployObject.ObjectType	getType()	Returns the type of this object.
boolean	isStoreChecksum()	Indicates whether the checksum of this object should be stored.
IDeployObject	setChecksum(java.lang.String checksum)	Sets the checksum of this object.
<T extends lumis.portal.deployment.process.IChecksumListener> IDeployObject	setChecksumListener(T listener)	Sets the checksum listener of this object.
IDeployObject	setId(java.lang.String id)	Sets the identifier of this object.
IDeployObject	setStoreChecksum(boolean isStoreChecksum)	Sets whether the checksum of this object should be stored.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleObject

protected ModuleObject()

Method Detail

getFiles

public java.util.Map<java.lang.String,IDeployObject> getFiles()

Returns a map with all files present in this module.

Returns:

a map with all files present in this module.

Since:

8.1.0

getId

public java.lang.String getId()

Description copied from interface: IDeployObject

Returns the identifier of this object.

Specified by:

getId in interface IDeployObject

Returns:

the identifier of this object.

setId

public IDeployObject setId(java.lang.String id)

Description copied from interface: IDeployObject

Sets the identifier of this object.

Specified by:

setId in interface IDeployObject

Parameters:

id - the identifier of this object.

Returns:

this object.

getInnerObjects

public java.util.Collection<IDeployObject> getInnerObjects()

Description copied from interface: IDeployObject

Returns a collection with the inner objects.

Specified by:

getInnerObjects in interface IDeployObject

Returns:

a collection with the inner objects.

getChecksum

public java.lang.String getChecksum()

Description copied from interface: IDeployObject

Returns the checksum of this object.

Specified by:

getChecksum in interface IDeployObject

Returns:

the checksum of this object.

setChecksum

public IDeployObject setChecksum(java.lang.String checksum)

Description copied from interface: IDeployObject

Sets the checksum of this object.

Specified by:

setChecksum in interface IDeployObject

Parameters:

checksum - the checksum of this object.

Returns:

this object.

setChecksumListener

public <T extends lumis.portal.deployment.process.IChecksumListener> IDeployObject setChecksumListener(T listener)

Description copied from interface: IDeployObject

Sets the checksum listener of this object.

Specified by:

setChecksumListener in interface IDeployObject

Parameters:

listener - the checksum listener of this object.

Returns:

this object.

getChecksumListener

public <T extends lumis.portal.deployment.process.IChecksumListener> T getChecksumListener()

Description copied from interface: IDeployObject

Returns the checksum listener of this object.

Specified by:

getChecksumListener in interface IDeployObject

Returns:

the checksum listener of this object.

isStoreChecksum

public boolean isStoreChecksum()

Description copied from interface: IDeployObject

Indicates whether the checksum of this object should be stored.

Specified by:

isStoreChecksum in interface IDeployObject

Returns:

whether the checksum of this object should be stored.

setStoreChecksum

public IDeployObject setStoreChecksum(boolean isStoreChecksum)

Description copied from interface: IDeployObject

Sets whether the checksum of this object should be stored.

Specified by:

setStoreChecksum in interface IDeployObject

Parameters:

isStoreChecksum - whether the checksum of this object should be stored.

Returns:

this object.

find

public java.util.Collection<IDeployObject> find(IDeployObject.ObjectType type,
                                                java.util.EnumSet<IDeployObject.ObjectType> allowedInnerObjects)

Description copied from interface: IDeployObject

Find all objects of the given type in subtree, but discards subtrees when their root type is not contained in the given set.

Specified by:

find in interface IDeployObject

Parameters:

type - the type to be search.

allowedInnerObjects - the allowed inner objects types.

Returns:

all objects of the given type in subtree, but discards subtrees when their root type is not contained in the given set.

find

public IDeployObject find(java.lang.String id,
                          IDeployObject.ObjectType objectType,
                          java.util.EnumSet<IDeployObject.ObjectType> allowedInnerObjects)

Description copied from interface: IDeployObject

Finds the object with the given identifier of the given type in subtree. Don't search subtrees of objects of types not contained in the given set.

Specified by:

find in interface IDeployObject

Parameters:

id - the object identifier.

objectType - the object type.

allowedInnerObjects - the allowed inner objects types.

getType

public IDeployObject.ObjectType getType()

Description copied from interface: IDeployObject

Returns the type of this object.

Specified by:

getType in interface IDeployObject

Returns:

the type of this object.

accumulateChecksum

public boolean accumulateChecksum()

Description copied from interface: IDeployObject

Indicates whether the checksum of this object should accumulate the subtree.

Specified by:

accumulateChecksum in interface IDeployObject

Returns:

whether the checksum of this object should accumulate the subtree.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object