ATermList (ATerm Java 1.8.2-p1 API)

All Superinterfaces:

ATerm, Identifiable, jjtraveler.Visitable

All Known Implementing Classes:

ATermListImpl
```
public interface ATermList
extends ATerm
```
This interface describes the functionality of an ATermList

Author:

Hayco de Jong (jong@cwi.nl), Pieter Olivier (olivierp@cwi.nl)

Field Summary
- Fields inherited from interface aterm.ATerm
  AFUN, APPL, BLOB, INT, LIST, LONG, PLACEHOLDER, REAL

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`ATerm`	`elementAt(int i)` Gets the element at a specific index of this list.
`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.
`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.
`int`	`indexOf(ATerm el, int start)` Gets the index of the first occurance of a term in this list.
`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.
`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 i)` 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.

Methods inherited from interface aterm.ATerm
equals, getAnnotation, getAnnotations, getFactory, getType, hasAnnotations, hashCode, isEqual, make, match, match, removeAnnotation, removeAnnotations, setAnnotation, setAnnotations, toString, writeToSharedTextFile, writeToTextFile

Methods inherited from interface aterm.Visitable
accept

Methods inherited from interface jjtraveler.Visitable
getChildAt, getChildCount, setChildAt

Methods inherited from interface aterm.Identifiable
getUniqueIdentifier

- Method Detail
  - isEmpty
```
boolean isEmpty()
```
    Checks if this list is the empty list.
    
    Returns:
    true if this list is empty, false otherwise.
  - getLength
```
int getLength()
```
    Gets the length (number of elements) of this list.
    
    Returns:
    the length of this list.
  - getFirst
```
ATerm getFirst()
```
    Gets the first element of this list.
    
    Returns:
    the first element of this list.
  - getLast
```
ATerm getLast()
```
    Gets the last element of this list.
    
    Returns:
    the last element of this list.
  - getEmpty
```
ATermList getEmpty()
```
    Gets the empty list associated to this list.
    
    Returns:
    the empty list.
  - getNext
```
ATermList getNext()
```
    Gets the tail (all but the first element) of this list.
    
    Returns:
    the tail of this list.
  - indexOf
```
int indexOf(ATerm el,
          int start)
```
    Gets the index of the first occurance of a term in this list. Lookup starts at a given index (0 being the first element).
    
    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.
    
    Throws:
    
    IllegalArgumentException - when start > length of list || start < -length
    See Also:
    lastIndexOf(aterm.ATerm, int)
  - lastIndexOf
```
int lastIndexOf(ATerm el,
              int start)
```
    Gets the last occurance of a term in this list. Lookup starts at a given index (0 being the first element).
    
    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:
    indexOf(aterm.ATerm, int)
  - concat
```
ATermList concat(ATermList rhs)
```
    Concatenates a list to this list.
    
    Parameters:
    rhs - the list to concatenate to this list.
    
    Returns:
    the concatenation of this list and rhs
  - append
```
ATermList append(ATerm el)
```
    Appends an element to this list.
    
    Parameters:
    el - the element to append to this list.
    
    Returns:
    a list with el appended to it.
  - elementAt
```
ATerm elementAt(int i)
```
    Gets the element at a specific index of this list.
    
    Parameters:
    i - the index of the required element.
    
    Returns:
    the ith element of this list.
    
    Throws:
    
    IndexOutOfBoundsException - if i does not refer to a position in this list.
  - remove
```
ATermList remove(ATerm el)
```
    Removes one occurance of an element from this list.
    
    Parameters:
    el - the element to be removed.
    
    Returns:
    this list with one occurance of el removed.
  - removeElementAt
```
ATermList removeElementAt(int i)
```
    Removes the element at a specific index in this list.
    
    Parameters:
    i - the index of the element to be removed.
    
    Returns:
    a list with the ith element removed.
    
    Throws:
    
    IndexOutOfBoundsException - if i does not refer to a position in this list.
  - removeAll
```
ATermList removeAll(ATerm el)
```
    Removes all occurances of an element in this list.
    
    Parameters:
    el - the element to be removed.
    
    Returns:
    this list with all occurances of el removed.
  - insert
```
ATermList insert(ATerm el)
```
    Inserts a term in front of this list.
    
    Parameters:
    el - the element to be inserted.
    
    Returns:
    a list with el inserted.
  - insertAt
```
ATermList insertAt(ATerm el,
                 int i)
```
    Inserts an element at a specific position in this list.
    
    Parameters:
    el - the element to be inserted.
    i - the index at which to insert.
    
    Returns:
    a list with el inserted as ith element.
  - getPrefix
```
ATermList getPrefix()
```
    Gets the prefix (all but the last element) of this list.
    
    Returns:
    the prefix of this list.
  - getSlice
```
ATermList getSlice(int start,
                 int end)
```
    Gets a portion (slice) of this list.
    
    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
```
ATermList replace(ATerm el,
                int i)
```
    Replaces a specific term in this list with another.
    
    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.
    
    Throws:
    
    IndexOutOfBoundsException - if i does not refer to a position in this list.
  - reverse
```
ATermList reverse()
```
    Reverses the elements of this list.
    
    Returns:
    a reverse order copy of this list.
  - dictGet
```
ATerm dictGet(ATerm key)
```
    Retrieves an element from a dictionary list. A dictionary list is a list of [key,value] pairs.
    
    Parameters:
    key - the key to look for
    
    Returns:
    the value associated with key, or null when key is not present.
  - dictPut
```
ATermList dictPut(ATerm key,
                ATerm value)
```
    Sets the value for an element in a dictionary list. A dictionary list is a list of [key,value] pairs.
    
    Parameters:
    key - the key to set
    value - the value to associate with key
    
    Returns:
    the new dictionary list
  - dictRemove
```
ATermList dictRemove(ATerm key)
```
    Removes an element from a dictionary list. A dictionary list is a list of [key,value] pairs.
    
    Parameters:
    key - the key to remove
    
    Returns:
    the new dictionary list

Interface ATermList

Field Summary

Fields inherited from interface aterm.ATerm

Method Summary

Methods inherited from interface aterm.ATerm

Methods inherited from interface aterm.Visitable

Methods inherited from interface jjtraveler.Visitable

Methods inherited from interface aterm.Identifiable

Method Detail

isEmpty

getLength

getFirst

getLast

getEmpty

getNext

indexOf

lastIndexOf

concat

append

elementAt

remove

removeElementAt

removeAll

insert

insertAt

getPrefix

getSlice

replace

reverse

dictGet

dictPut

dictRemove