com.izforge.izpack.api.rules

Class Condition

java.lang.Object

com.izforge.izpack.api.rules.Condition

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CompareCondition, ConditionReference, ConditionWithMultipleOperands

public abstract class Condition
extends Object
implements Serializable

Abstract base class for all conditions. Implementations of custom conditions have to derive from this class.

Author:

Dennis Reil

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Condition()

Method Summary

Modifier and Type	Method and Description
String	getDependenciesDetails()
String	getId()
InstallData	getInstallData()
abstract Set<String>	getVarRefs() This element will be called when the order of variable resolutions is determined.
abstract boolean	isTrue()
abstract void	makeXMLData(IXMLElement conditionRoot) This element will be called by the RulesEngine to serialize the configuration of a condition into XML.
abstract void	readFromXML(IXMLElement xmlcondition) Parse and initialize this condition from parsed values.
void	setId(String id)
void	setInstallData(InstallData installData)

Methods inherited from class java.lang.Object

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

Constructor Detail

Condition

public Condition()

Method Detail

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

readFromXML

public abstract void readFromXML(IXMLElement xmlcondition)
                          throws Exception

Parse and initialize this condition from parsed values. An exception should be thrown if the condition description has not the expected XML format, something missing or obviously bad values.

Parameters:

xmlcondition - the root element to parse from

Throws:

Exception - on a parse error

isTrue

public abstract boolean isTrue()

getInstallData

public InstallData getInstallData()

setInstallData

public void setInstallData(InstallData installData)

getDependenciesDetails

public String getDependenciesDetails()

makeXMLData

public abstract void makeXMLData(IXMLElement conditionRoot)

This element will be called by the RulesEngine to serialize the configuration of a condition into XML.

Parameters:

conditionRoot - the root element for this condition

getVarRefs

public abstract Set<String> getVarRefs()

This element will be called when the order of variable resolutions is determined.

Returns:

the names of all variables referenced by this condition