tom.engine.adt.tominstruction.types.constraintinstruction
Class ConstraintInstruction

java.lang.Object
  tom.engine.adt.tominstruction.TomInstructionAbstractType
      tom.engine.adt.tominstruction.types.ConstraintInstruction
          tom.engine.adt.tominstruction.types.constraintinstruction.ConstraintInstruction

All Implemented Interfaces:

Comparable, shared.SharedObject, shared.SharedObjectWithID, Visitable

public final class ConstraintInstruction
extends ConstraintInstruction
implements Visitable

Field Summary

Fields inherited from class tom.engine.adt.tominstruction.types.ConstraintInstruction

idConv

Fields inherited from class tom.engine.adt.tominstruction.TomInstructionAbstractType

atermFactory, factory

Method Summary

int	compareTo(Object o) Compares two terms.
int	compareToLPO(Object o) Compares two terms.
shared.SharedObject	duplicate() Copy the object and returns the copy
boolean	equivalent(shared.SharedObject obj) Checks if a SharedObject is equivalent to the current object
static ConstraintInstruction	fromTerm(aterm.ATerm trm, ATermConverter atConv) Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.tominstruction.types.ConstraintInstruction from it
Instruction	getAction() Returns the attribute tom.engine.adt.tominstruction.types.Instruction
Visitable	getChildAt(int index) Returns the child at the specified index
int	getChildCount() Returns the number of childs of the term
Visitable[]	getChildren() Returns the whole children of the term
Constraint	getConstraint() Returns the attribute tom.engine.adt.tomconstraint.types.Constraint
OptionList	getOptions() Returns the attribute tom.engine.adt.tomoption.types.OptionList
int	hashCode() Returns hashCode
protected int	hashFunction() Compute a hashcode for this term.
boolean	isConstraintInstruction() Returns true if the term is rooted by the symbol ConstraintInstruction
static ConstraintInstruction	make(Constraint _Constraint, Instruction _Action, OptionList _Options) Constructor that builds a term rooted by ConstraintInstruction
ConstraintInstruction	setAction(Instruction set_arg) Sets and returns the attribute tom.engine.adt.tominstruction.types.ConstraintInstruction
Visitable	setChildAt(int index, Visitable v) Set the child at the specified index
Visitable	setChildren(Visitable[] childs) Set children to the term
ConstraintInstruction	setConstraint(Constraint set_arg) Sets and returns the attribute tom.engine.adt.tominstruction.types.ConstraintInstruction
ConstraintInstruction	setOptions(OptionList set_arg) Sets and returns the attribute tom.engine.adt.tominstruction.types.ConstraintInstruction
String	symbolName() Returns the name of the symbol
aterm.ATerm	toATerm() Returns an ATerm representation of this term.
void	toStringBuilder(StringBuilder buffer) Appends a string representation of this term to the buffer given as argument.

Methods inherited from class tom.engine.adt.tominstruction.types.ConstraintInstruction

fromStream, fromStream, fromString, fromString, fromTerm, length, reverse

Methods inherited from class tom.engine.adt.tominstruction.TomInstructionAbstractType

convertATermToBoolean, convertATermToChar, convertATermToDouble, convertATermToFloat, convertATermToInt, convertATermToLong, convertATermToString, getUniqueIdentifier, setUniqueIdentifier, toString

Methods inherited from class java.lang.Object

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

Method Detail

make

public static ConstraintInstruction make(Constraint _Constraint,
                                         Instruction _Action,
                                         OptionList _Options)

Constructor that builds a term rooted by ConstraintInstruction

Returns:

a term rooted by ConstraintInstruction

symbolName

public String symbolName()

Returns the name of the symbol

Specified by:

symbolName in class TomInstructionAbstractType

Returns:

the name of the symbol

duplicate

public shared.SharedObject duplicate()

Copy the object and returns the copy

Specified by:

duplicate in interface shared.SharedObject

Returns:

a clone of the SharedObject

toStringBuilder

public void toStringBuilder(StringBuilder buffer)

Appends a string representation of this term to the buffer given as argument.

Specified by:

toStringBuilder in class TomInstructionAbstractType

Parameters:

buffer - the buffer to which a string represention of this term is appended.

compareToLPO

public int compareToLPO(Object o)

Compares two terms. This functions implements a total lexicographic path ordering.

Specified by:

compareToLPO in class TomInstructionAbstractType

Parameters:

o - object to which this term is compared

Returns:

a negative integer, zero, or a positive integer as this term is less than, equal to, or greater than the argument

Throws:

ClassCastException - in case of invalid arguments

RuntimeException - if unable to compare childs

compareTo

public int compareTo(Object o)

Compares two terms. This functions implements a total order.

Specified by:

compareTo in interface Comparable

Specified by:

compareTo in class TomInstructionAbstractType

Parameters:

o - object to which this term is compared

Returns:

a negative integer, zero, or a positive integer as this term is less than, equal to, or greater than the argument

Throws:

ClassCastException - in case of invalid arguments

RuntimeException - if unable to compare childs

hashCode

public final int hashCode()

Returns hashCode

Specified by:

hashCode in interface shared.SharedObject

Overrides:

hashCode in class Object

Returns:

hashCode

equivalent

public final boolean equivalent(shared.SharedObject obj)

Checks if a SharedObject is equivalent to the current object

Specified by:

equivalent in interface shared.SharedObject

Parameters:

obj - SharedObject to test

Returns:

true if obj is a ConstraintInstruction and its members are equal, else false

isConstraintInstruction

public boolean isConstraintInstruction()

Returns true if the term is rooted by the symbol ConstraintInstruction

Overrides:

isConstraintInstruction in class ConstraintInstruction

Returns:

true, because this is rooted by ConstraintInstruction

getConstraint

public Constraint getConstraint()

Returns the attribute tom.engine.adt.tomconstraint.types.Constraint

Overrides:

getConstraint in class ConstraintInstruction

Returns:

the attribute tom.engine.adt.tomconstraint.types.Constraint

setConstraint

public ConstraintInstruction setConstraint(Constraint set_arg)

Sets and returns the attribute tom.engine.adt.tominstruction.types.ConstraintInstruction

Overrides:

setConstraint in class ConstraintInstruction

Parameters:

set_arg - the argument to set

Returns:

the attribute tom.engine.adt.tomconstraint.types.Constraint which just has been set

getAction

public Instruction getAction()

Returns the attribute tom.engine.adt.tominstruction.types.Instruction

Overrides:

getAction in class ConstraintInstruction

Returns:

the attribute tom.engine.adt.tominstruction.types.Instruction

setAction

public ConstraintInstruction setAction(Instruction set_arg)

Sets and returns the attribute tom.engine.adt.tominstruction.types.ConstraintInstruction

Overrides:

setAction in class ConstraintInstruction

Parameters:

set_arg - the argument to set

Returns:

the attribute tom.engine.adt.tominstruction.types.Instruction which just has been set

getOptions

public OptionList getOptions()

Returns the attribute tom.engine.adt.tomoption.types.OptionList

Overrides:

getOptions in class ConstraintInstruction

Returns:

the attribute tom.engine.adt.tomoption.types.OptionList

setOptions

public ConstraintInstruction setOptions(OptionList set_arg)

Sets and returns the attribute tom.engine.adt.tominstruction.types.ConstraintInstruction

Overrides:

setOptions in class ConstraintInstruction

Parameters:

set_arg - the argument to set

Returns:

the attribute tom.engine.adt.tomoption.types.OptionList which just has been set

toATerm

public aterm.ATerm toATerm()

Returns an ATerm representation of this term.

Overrides:

toATerm in class ConstraintInstruction

Returns:

an ATerm representation of this term.

fromTerm

public static ConstraintInstruction fromTerm(aterm.ATerm trm,
                                             ATermConverter atConv)

Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.tominstruction.types.ConstraintInstruction from it

Parameters:

trm - ATerm to convert into a Gom term

atConv - ATerm Converter used to convert the ATerm

Returns:

the Gom term

getChildCount

public int getChildCount()

Returns the number of childs of the term

Specified by:

getChildCount in interface Visitable

Returns:

the number of childs of the term

getChildAt

public Visitable getChildAt(int index)

Returns the child at the specified index

Specified by:

getChildAt in interface Visitable

Parameters:

index - index of the child to return; must be nonnegative and less than the childCount

Returns:

the child at the specified index

Throws:

IndexOutOfBoundsException - if the index out of range

setChildAt

public Visitable setChildAt(int index,
                            Visitable v)

Set the child at the specified index

Specified by:

setChildAt in interface Visitable

Parameters:

index - index of the child to set; must be nonnegative and less than the childCount

v - child to set at the specified index

Returns:

the child which was just set

Throws:

IndexOutOfBoundsException - if the index out of range

setChildren

public Visitable setChildren(Visitable[] childs)

Set children to the term

Specified by:

setChildren in interface Visitable

Parameters:

childs - array of children to set

Returns:

an array of children which just were set

Throws:

IndexOutOfBoundsException - if length of "childs" is different than 3

getChildren

public Visitable[] getChildren()

Returns the whole children of the term

Specified by:

getChildren in interface Visitable

Returns:

the children of the term

hashFunction

protected int hashFunction()

Compute a hashcode for this term. (for internal use)

Returns:

a hash value