aterm.pure

Class ATermListImpl

java.lang.Object

aterm.pure.ATermVisitableImpl

aterm.pure.ATermImpl

aterm.pure.ATermListImpl

All Implemented Interfaces:

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

public class ATermListImpl
extends ATermImpl
implements ATermList

Field Summary

Fields inherited from class aterm.pure.ATermImpl

factory

Fields inherited from interface aterm.ATerm

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ATermListImpl(PureFactory factory)
protected	ATermListImpl(PureFactory factory, ATermList annos, ATerm first, ATermList next)

Method Summary

Methods

Modifier and Type	Method and Description
Visitable	accept(Visitor v)
ATermList	append(ATerm el) Appends an element to this list.
ATermList	concat(ATermList rhs) Concatenates a list to this list.
ATerm	dictGet(ATerm key) Retrieves an element from a dictionary list.
ATermList	dictPut(ATerm key, ATerm value) Sets the value for an element in a dictionary list.
ATermList	dictRemove(ATerm key) Removes an element from a dictionary list.
shared.SharedObject	duplicate()
ATerm	elementAt(int index) Gets the element at a specific index of this list.
boolean	equivalent(shared.SharedObject obj)
protected int	findEmptyHashCode()
ATermList	getEmpty() Gets the empty list associated to this list.
ATerm	getFirst() Gets the first element of this list.
ATerm	getLast() Gets the last element of this list.
int	getLength() Gets the length (number of elements) of this list.
ATermList	getNext() Gets the tail (all but the first element) of this list.
int	getNrSubTerms()
ATermList	getPrefix() Gets the prefix (all but the last element) of this list.
ATermList	getSlice(int start, int end) Gets a portion (slice) of this list.
ATerm	getSubTerm(int index)
int	getType() Gets the type of this term.
int	indexOf(ATerm el, int start) Gets the index of the first occurance of a term in this list.
protected void	init(int hashCode, ATermList annos, ATerm first, ATermList next)
protected void	initHashCode(ATermList annos, ATerm first, ATermList next)
ATermList	insert(ATerm el) Inserts a term in front of this list.
ATermList	insertAt(ATerm el, int i) Inserts an element at a specific position in this list.
boolean	isEmpty() Checks if this list is the empty list.
int	lastIndexOf(ATerm el, int start) Gets the last occurance of a term in this list.
protected ATermList	make(ATerm head, ATermList tail)
protected ATermList	make(ATerm head, ATermList tail, ATermList annos)
ATerm	make(List<Object> args) Create a new term based on this term as a pattern and a list of arguments.
protected boolean	match(ATerm pattern, List<Object> list)
ATermList	remove(ATerm el) Removes one occurance of an element from this list.
ATermList	removeAll(ATerm el) Removes all occurances of an element in this list.
ATermList	removeElementAt(int index) Removes the element at a specific index in this list.
ATermList	replace(ATerm el, int i) Replaces a specific term in this list with another.
ATermList	reverse() Reverses the elements of this list.
ATerm	setAnnotations(ATermList annos) Sets all annotations of this term.
ATerm	setSubTerm(int index, ATerm t)

Methods inherited from class aterm.pure.ATermImpl

equals, getAnnotation, getAnnotations, getFactory, getPureFactory, getUniqueIdentifier, hasAnnotations, hashCode, init, internSetAnnotations, isEqual, match, match, removeAnnotation, removeAnnotations, setAnnotation, setHashCode, setUniqueIdentifier, toString, writeToSharedTextFile, writeToTextFile, writeToTextFile

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

equals, getAnnotation, getAnnotations, getFactory, hasAnnotations, hashCode, isEqual, match, match, removeAnnotation, removeAnnotations, setAnnotation, toString, writeToSharedTextFile, writeToTextFile

Methods inherited from interface jjtraveler.Visitable

getChildAt, getChildCount, setChildAt

Methods inherited from interface aterm.Identifiable

getUniqueIdentifier

Constructor Detail

ATermListImpl

protected ATermListImpl(PureFactory factory)

ATermListImpl

protected ATermListImpl(PureFactory factory,
             ATermList annos,
             ATerm first,
             ATermList next)

Method Detail

getType

public int getType()

Description copied from interface: ATerm

Gets the type of this term.

Specified by:

getType in interface ATerm

Returns:

the type of this ATerm.

See Also:

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

init

protected void init(int hashCode,
        ATermList annos,
        ATerm first,
        ATermList next)

Parameters:

hashCode -

annos -

first -

next -

initHashCode

protected void initHashCode(ATermList annos,
                ATerm first,
                ATermList next)

Parameters:

annos -

first -

next -

duplicate

public shared.SharedObject duplicate()

Specified by:

duplicate in interface shared.SharedObject

equivalent

public boolean equivalent(shared.SharedObject obj)

Specified by:

equivalent in interface shared.SharedObject

insert

public ATermList insert(ATerm el)

Description copied from interface: ATermList

Inserts a term in front of this list.

Specified by:

insert in interface ATermList

Parameters:

el - the element to be inserted.

Returns:

a list with el inserted.

make

protected ATermList make(ATerm head,
             ATermList tail)

make

protected ATermList make(ATerm head,
             ATermList tail,
             ATermList annos)

getEmpty

public ATermList getEmpty()

Description copied from interface: ATermList

Gets the empty list associated to this list.

Specified by:

getEmpty in interface ATermList

Returns:

the empty list.

setAnnotations

public ATerm setAnnotations(ATermList annos)

Description copied from interface: ATerm

Sets all annotations of this term.

Specified by:

setAnnotations in interface ATerm

Parameters:

annos - the annotations to set.

Returns:

a new version of this term with the requested annotations.

See Also:

ATerm.getAnnotations()

match

protected boolean match(ATerm pattern,
            List<Object> list)

make

public ATerm make(List<Object> args)

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

Overrides:

make in class ATermImpl

Parameters:

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

Returns:

the constructed aterm

isEmpty

public boolean isEmpty()

Description copied from interface: ATermList

Checks if this list is the empty list.

Specified by:

isEmpty in interface ATermList

Returns:

true if this list is empty, false otherwise.

getLength

public int getLength()

Description copied from interface: ATermList

Gets the length (number of elements) of this list.

Specified by:

getLength in interface ATermList

Returns:

the length of this list.

getFirst

public ATerm getFirst()

Description copied from interface: ATermList

Gets the first element of this list.

Specified by:

getFirst in interface ATermList

Returns:

the first element of this list.

getNext

public ATermList getNext()

Description copied from interface: ATermList

Gets the tail (all but the first element) of this list.

Specified by:

getNext in interface ATermList

Returns:

the tail of this list.

getLast

public ATerm getLast()

Description copied from interface: ATermList

Gets the last element of this list.

Specified by:

getLast in interface ATermList

Returns:

the last element of this list.

indexOf

public int indexOf(ATerm el,
          int start)

Description copied from interface: ATermList

Gets the index of the first occurance of a term in this list. Lookup starts at a given index (0 being the first element).

Specified by:

indexOf in interface ATermList

Parameters:

el - the element to look for.

start - the starting position of the lookup. Negative start implies searching backwards from the tail of the list.

Returns:

the index of the first occurance of el in this list, or -1 if el does not occur.

See Also:

ATermList.lastIndexOf(aterm.ATerm, int)

lastIndexOf

public int lastIndexOf(ATerm el,
              int start)

Description copied from interface: ATermList

Gets the last occurance of a term in this list. Lookup starts at a given index (0 being the first element).

Specified by:

lastIndexOf in interface ATermList

Parameters:

el - the element to look for.

start - the starting position of the lookup.

Returns:

the index of the last occurance of el in this list, or -1 if el does not occur.

See Also:

ATermList.indexOf(aterm.ATerm, int)

concat

public ATermList concat(ATermList rhs)

Description copied from interface: ATermList

Concatenates a list to this list.

Specified by:

concat in interface ATermList

Parameters:

rhs - the list to concatenate to this list.

Returns:

the concatenation of this list and rhs

append

public ATermList append(ATerm el)

Description copied from interface: ATermList

Appends an element to this list.

Specified by:

append in interface ATermList

Parameters:

el - the element to append to this list.

Returns:

a list with el appended to it.

elementAt

public ATerm elementAt(int index)

Description copied from interface: ATermList

Gets the element at a specific index of this list.

Specified by:

elementAt in interface ATermList

Parameters:

index - the index of the required element.

Returns:

the ith element of this list.

remove

public ATermList remove(ATerm el)

Description copied from interface: ATermList

Removes one occurance of an element from this list.

Specified by:

remove in interface ATermList

Parameters:

el - the element to be removed.

Returns:

this list with one occurance of el removed.

removeElementAt

public ATermList removeElementAt(int index)

Description copied from interface: ATermList

Removes the element at a specific index in this list.

Specified by:

removeElementAt in interface ATermList

Parameters:

index - the index of the element to be removed.

Returns:

a list with the ith element removed.

removeAll

public ATermList removeAll(ATerm el)

Description copied from interface: ATermList

Removes all occurances of an element in this list.

Specified by:

removeAll in interface ATermList

Parameters:

el - the element to be removed.

Returns:

this list with all occurances of el removed.

insertAt

public ATermList insertAt(ATerm el,
                 int i)

Description copied from interface: ATermList

Inserts an element at a specific position in this list.

Specified by:

insertAt in interface ATermList

Parameters:

el - the element to be inserted.

i - the index at which to insert.

Returns:

a list with el inserted as ith element.

getPrefix

public ATermList getPrefix()

Description copied from interface: ATermList

Gets the prefix (all but the last element) of this list.

Specified by:

getPrefix in interface ATermList

Returns:

the prefix of this list.

getSlice

public ATermList getSlice(int start,
                 int end)

Description copied from interface: ATermList

Gets a portion (slice) of this list.

Specified by:

getSlice in interface ATermList

Parameters:

start - the start of the slice (included).

end - the end of the slice (excluded).

Returns:

the portion of this list between start and end.

replace

public ATermList replace(ATerm el,
                int i)

Description copied from interface: ATermList

Replaces a specific term in this list with another.

Specified by:

replace in interface ATermList

Parameters:

el - the element to be put into this list.

i - the index of the element in this list to be replaced.

Returns:

this list with the ith element replaced by el.

reverse

public ATermList reverse()

Description copied from interface: ATermList

Reverses the elements of this list.

Specified by:

reverse in interface ATermList

Returns:

a reverse order copy of this list.

dictGet

public ATerm dictGet(ATerm key)

Description copied from interface: ATermList

Retrieves an element from a dictionary list. A dictionary list is a list of [key,value] pairs.

Specified by:

dictGet in interface ATermList

Parameters:

key - the key to look for

Returns:

the value associated with key, or null when key is not present.

dictPut

public ATermList dictPut(ATerm key,
                ATerm value)

Description copied from interface: ATermList

Sets the value for an element in a dictionary list. A dictionary list is a list of [key,value] pairs.

Specified by:

dictPut in interface ATermList

Parameters:

key - the key to set

value - the value to associate with key

Returns:

the new dictionary list

dictRemove

public ATermList dictRemove(ATerm key)

Description copied from interface: ATermList

Removes an element from a dictionary list. A dictionary list is a list of [key,value] pairs.

Specified by:

dictRemove in interface ATermList

Parameters:

key - the key to remove

Returns:

the new dictionary list

accept

public Visitable accept(Visitor v)
                 throws jjtraveler.VisitFailure

Throws:

jjtraveler.VisitFailure

getNrSubTerms

public int getNrSubTerms()

Overrides:

getNrSubTerms in class ATermImpl

getSubTerm

public ATerm getSubTerm(int index)

Overrides:

getSubTerm in class ATermImpl

setSubTerm

public ATerm setSubTerm(int index,
               ATerm t)

Overrides:

setSubTerm in class ATermImpl

findEmptyHashCode

protected int findEmptyHashCode()