tom.engine.adt.code.types.code
Class Tom

java.lang.Object
  tom.engine.adt.code.CodeAbstractType
      tom.engine.adt.code.types.Code
          tom.engine.adt.code.types.code.Tom

All Implemented Interfaces:

Comparable, shared.SharedObject, shared.SharedObjectWithID, Visitable

public final class Tom
extends Code
implements Visitable

Tom main construct to embed a Tom island It will be generated on a single line

Field Summary

Fields inherited from class tom.engine.adt.code.types.Code

idConv

Fields inherited from class tom.engine.adt.code.CodeAbstractType

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 Code	fromTerm(aterm.ATerm trm, ATermConverter atConv) Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.code.types.Code from it
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
CodeList	getCodeList() Returns the attribute tom.engine.adt.code.types.CodeList
int	hashCode() Returns hashCode
protected int	hashFunction() Compute a hashcode for this term.
boolean	isTom() Returns true if the term is rooted by the symbol Tom
static Tom	make(CodeList _CodeList) Tom main construct to embed a Tom island It will be generated on a single line
Visitable	setChildAt(int index, Visitable v) Set the child at the specified index
Visitable	setChildren(Visitable[] childs) Set children to the term
Code	setCodeList(CodeList set_arg) Sets and returns the attribute tom.engine.adt.code.types.Code
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.code.types.Code

fromStream, fromStream, fromString, fromString, fromTerm, getAstDeclaration, getAstInstruction, getBq, getTl, isBQTermToCode, isDeclarationToCode, isInstructionToCode, isTargetLanguageToCode, isTomInclude, length, reverse, setAstDeclaration, setAstInstruction, setBq, setTl

Methods inherited from class tom.engine.adt.code.CodeAbstractType

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 Tom make(CodeList _CodeList)

Tom main construct to embed a Tom island It will be generated on a single line

Parameters:

_CodeList - a list of Code that corresponds to islands or lakes

symbolName

public String symbolName()

Returns the name of the symbol

Specified by:

symbolName in class CodeAbstractType

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 CodeAbstractType

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 CodeAbstractType

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 CodeAbstractType

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 Tom and its members are equal, else false

isTom

public boolean isTom()

Returns true if the term is rooted by the symbol Tom

Overrides:

isTom in class Code

Returns:

true, because this is rooted by Tom

getCodeList

public CodeList getCodeList()

Returns the attribute tom.engine.adt.code.types.CodeList

Overrides:

getCodeList in class Code

Returns:

the attribute tom.engine.adt.code.types.CodeList

setCodeList

public Code setCodeList(CodeList set_arg)

Sets and returns the attribute tom.engine.adt.code.types.Code

Overrides:

setCodeList in class Code

Parameters:

set_arg - the argument to set

Returns:

the attribute tom.engine.adt.code.types.CodeList which just has been set

toATerm

public aterm.ATerm toATerm()

Returns an ATerm representation of this term.

Overrides:

toATerm in class Code

Returns:

an ATerm representation of this term.

fromTerm

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

Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.code.types.Code 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 1

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