aterm.pure

Class ATermImpl

java.lang.Object

aterm.pure.ATermVisitableImpl

aterm.pure.ATermImpl

All Implemented Interfaces:

ATerm, Identifiable, jjtraveler.Visitable, shared.SharedObject, shared.SharedObjectWithID

Direct Known Subclasses:

AFunImpl, ATermApplImpl, ATermBlobImpl, ATermIntImpl, ATermListImpl, ATermLongImpl, ATermPlaceholderImpl, ATermRealImpl

public abstract class ATermImpl
extends ATermVisitableImpl
implements ATerm, shared.SharedObjectWithID

Field Summary

Fields

Modifier and Type	Field and Description
protected PureFactory	factory

Fields inherited from interface aterm.ATerm

AFUN, APPL, BLOB, INT, LIST, LONG, PLACEHOLDER, REAL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ATermImpl(PureFactory factory)
protected	ATermImpl(PureFactory factory, ATermList annos)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks equality of this term against any java object.
ATerm	getAnnotation(ATerm label) Gets a annotation associated with specific label from this term.
ATermList	getAnnotations() Gets all annotations of this term.
ATermFactory	getFactory() Retrieves the factory responsible for creating this ATerm.
int	getNrSubTerms()
protected PureFactory	getPureFactory()
ATerm	getSubTerm(int index)
int	getUniqueIdentifier()
boolean	hasAnnotations()
int	hashCode() Gets a hashcode value of this term.
protected void	init(int hashCode, ATermList annos)
protected void	internSetAnnotations(ATermList annos)
boolean	isEqual(ATerm term) Checks equality of this term against another term.
ATerm	make(List<Object> list) Create a new term based on this term as a pattern and a list of arguments.
List<Object>	match(ATerm pattern) Matches this term against a term pattern.
List<Object>	match(String pattern) Matches this term against a String pattern.
ATerm	removeAnnotation(ATerm label) Removes a specific annotation from this term.
ATerm	removeAnnotations() Removes all annotations of this term.
ATerm	setAnnotation(ATerm label, ATerm anno) Sets annotation of this term with given label.
protected void	setHashCode(int hashcode)
ATerm	setSubTerm(int index, ATerm t)
void	setUniqueIdentifier(int uniqueId)
String	toString() Gets a string representation of this term.
void	writeToSharedTextFile(OutputStream stream) Write a term to a shared text file/stream.
void	writeToTextFile(aterm.pure.ATermWriter writer)
void	writeToTextFile(OutputStream stream) Write a term to a text file/stream.

Methods inherited from class aterm.pure.ATermVisitableImpl

getChildAt, getChildCount, setChildAt

Methods inherited from class java.lang.Object

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

Methods inherited from interface aterm.ATerm

getType, setAnnotations

Methods inherited from interface aterm.Visitable

accept

Methods inherited from interface jjtraveler.Visitable

getChildAt, getChildCount, setChildAt

Methods inherited from interface shared.SharedObject

duplicate, equivalent

Field Detail

factory

protected PureFactory factory

Constructor Detail

ATermImpl

protected ATermImpl(PureFactory factory)

Parameters:

factory -

ATermImpl

protected ATermImpl(PureFactory factory,
         ATermList annos)

Method Detail

hashCode

public final int hashCode()

Description copied from interface: ATerm

Gets a hashcode value of this term.

Specified by:

hashCode in interface ATerm

Specified by:

hashCode in interface shared.SharedObject

Overrides:

hashCode in class Object

Returns:

the hashcode of this term.

setHashCode

protected void setHashCode(int hashcode)

internSetAnnotations

protected void internSetAnnotations(ATermList annos)

init

protected void init(int hashCode,
        ATermList annos)

Parameters:

hashCode -

annos -

getFactory

public ATermFactory getFactory()

Description copied from interface: ATerm

Retrieves the factory responsible for creating this ATerm.

Specified by:

getFactory in interface ATerm

Returns:

the factory that created this ATerm object.

getPureFactory

protected PureFactory getPureFactory()

hasAnnotations

public boolean hasAnnotations()

Specified by:

hasAnnotations in interface ATerm

setAnnotation

public ATerm setAnnotation(ATerm label,
                  ATerm anno)

Description copied from interface: ATerm

Sets annotation of this term with given label. If no annotation with this label exists, a new annotation is created, otherwise the existing annotation is updated.

Specified by:

setAnnotation in interface ATerm

Parameters:

label - the label of the annotation.

anno - the annotation itself.

Returns:

a new version of this term with the requested annotation.

See Also:

ATerm.getAnnotation(aterm.ATerm)

removeAnnotation

public ATerm removeAnnotation(ATerm label)

Description copied from interface: ATerm

Removes a specific annotation from this term.

Specified by:

removeAnnotation in interface ATerm

Parameters:

label - the label of the annotation to be removed.

Returns:

a new version of this term without the annotation.

See Also:

ATerm.setAnnotation(aterm.ATerm, aterm.ATerm)

getAnnotation

public ATerm getAnnotation(ATerm label)

Description copied from interface: ATerm

Gets a annotation associated with specific label from this term.

Specified by:

getAnnotation in interface ATerm

Parameters:

label - the label of the desired annotation.

Returns:

the annotation associated with label, or null if annotation with specified label does not exist.

See Also:

ATerm.setAnnotation(aterm.ATerm, aterm.ATerm)

removeAnnotations

public ATerm removeAnnotations()

Description copied from interface: ATerm

Removes all annotations of this term.

Specified by:

removeAnnotations in interface ATerm

Returns:

a new version of this term without annotations.

See Also:

ATerm.setAnnotations(aterm.ATermList)

getAnnotations

public ATermList getAnnotations()

Description copied from interface: ATerm

Gets all annotations of this term.

Specified by:

getAnnotations in interface ATerm

Returns:

all annotations of this term

See Also:

ATerm.setAnnotations(aterm.ATermList)

match

public List<Object> match(String pattern)

Description copied from interface: ATerm

Matches this term against a String pattern. The pattern is parsed into a term, which this term is then matched against.

Specified by:

match in interface ATerm

Parameters:

pattern - the string pattern to match this term against.

Returns:

a list containing the subterms matching the placeholders if the match succeeds, or null if the match fails.

See Also:

ATerm.match(ATerm)

match

public List<Object> match(ATerm pattern)

Description copied from interface: ATerm

Matches this term against a term pattern. A list containing the subterms matching the placeholders in the pattern is built as this term is matched against the pattern.

Specified by:

match in interface ATerm

Parameters:

pattern - The term pattern to match this term against.

Returns:

a list containing the subterms matching the placeholders if the match succeeds, or null if the match fails.

isEqual

public boolean isEqual(ATerm term)

Description copied from interface: ATerm

Checks equality of this term against another term. This method exists to keep a tight relation to the C-library. Experienced Java programmers might feel more comfortable using the ATerm.equals(java.lang.Object) method.

Specified by:

isEqual in interface ATerm

Parameters:

term - the term to check for equality.

Returns:

true iff terms are equal (including any annotations they might have!), false otherwise.

See Also:

ATerm.equals(Object)

equals

public boolean equals(Object obj)

Description copied from interface: ATerm

Checks equality of this term against any java object. Note that for two terms to be equal, any annotations they might have must be equal as well.

Specified by:

equals in interface ATerm

Overrides:

equals in class Object

Parameters:

obj - the object to check for equality.

Returns:

true iff term equals obj (including annotations).

See Also:

ATerm.isEqual(aterm.ATerm)

make

public ATerm make(List<Object> list)

Description copied from interface: ATerm

Create a new term based on this term as a pattern and a list of arguments.

Specified by:

make in interface ATerm

Parameters:

list - the list of arguments used to fill up holes in the pattern

Returns:

the constructed aterm

writeToTextFile

public void writeToTextFile(aterm.pure.ATermWriter writer)
                     throws IOException

Throws:

IOException

writeToSharedTextFile

public void writeToSharedTextFile(OutputStream stream)
                           throws IOException

Description copied from interface: ATerm

Write a term to a shared text file/stream. An efficient shared ASCII representation of this term is written to the stream.

Specified by:

writeToSharedTextFile in interface ATerm

Parameters:

stream - the stream to write this term to

Throws:

IOException

writeToTextFile

public void writeToTextFile(OutputStream stream)
                     throws IOException

Description copied from interface: ATerm

Write a term to a text file/stream.

Specified by:

writeToTextFile in interface ATerm

Parameters:

stream - the stream to write to

Throws:

IOException

toString

public String toString()

Description copied from interface: ATerm

Gets a string representation of this term.

Specified by:

toString in interface ATerm

Overrides:

toString in class Object

Returns:

a string representation of this term.

getNrSubTerms

public int getNrSubTerms()

Specified by:

getNrSubTerms in class ATermVisitableImpl

getSubTerm

public ATerm getSubTerm(int index)

Specified by:

getSubTerm in class ATermVisitableImpl

setSubTerm

public ATerm setSubTerm(int index,
               ATerm t)

Specified by:

setSubTerm in class ATermVisitableImpl

getUniqueIdentifier

public int getUniqueIdentifier()

Specified by:

getUniqueIdentifier in interface Identifiable

Specified by:

getUniqueIdentifier in interface shared.SharedObjectWithID

setUniqueIdentifier

public void setUniqueIdentifier(int uniqueId)

Specified by:

setUniqueIdentifier in interface shared.SharedObjectWithID