tom.engine.adt.tomslot.types
Class SlotList

java.lang.Object
  tom.engine.adt.tomslot.TomSlotAbstractType
      tom.engine.adt.tomslot.types.SlotList

All Implemented Interfaces:

Comparable, shared.SharedObject, shared.SharedObjectWithID, Visitable

Direct Known Subclasses:

concSlot

public abstract class SlotList
extends TomSlotAbstractType

Field Summary

protected static IdConverter

idConv

Fields inherited from class tom.engine.adt.tomslot.TomSlotAbstractType

atermFactory, factory

Constructor Summary

protected

SlotList() Sole constructor.

Method Summary

static SlotList	fromStream(InputStream stream) Returns a tom.engine.adt.tomslot.types.SlotList from a Stream without any conversion
static SlotList	fromStream(InputStream stream, ATermConverter atConv) Apply a conversion on the ATerm contained in the Stream and returns a tom.engine.adt.tomslot.types.SlotList from it
static SlotList	fromString(String s) Returns a tom.engine.adt.tomslot.types.SlotList from a String without any conversion
static SlotList	fromString(String s, ATermConverter atConv) Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.tomslot.types.SlotList from it
static SlotList	fromTerm(aterm.ATerm trm) Returns a tom.engine.adt.tomslot.types.SlotList from an ATerm without any conversion
static SlotList	fromTerm(aterm.ATerm trm, ATermConverter atConv) Apply a conversion on the ATerm and returns a tom.engine.adt.tomslot.types.SlotList
Collection<Slot>	getCollectionconcSlot() Returns a Collection extracted from the term
Slot	getHeadconcSlot() Returns the subterm corresponding to the slot HeadconcSlot
SlotList	getTailconcSlot() Returns the subterm corresponding to the slot TailconcSlot
boolean	isConsconcSlot() Returns true if the term is rooted by the symbol ConsconcSlot
boolean	isEmptyconcSlot() Returns true if the term is rooted by the symbol EmptyconcSlot
int	length() Returns the length of the list
SlotList	reverse() Returns an inverted term
SlotList	setHeadconcSlot(Slot _arg) Returns a new term where the subterm corresponding to the slot HeadconcSlot is replaced by the term given in argument.
SlotList	setTailconcSlot(SlotList _arg) Returns a new term where the subterm corresponding to the slot TailconcSlot is replaced by the term given in argument.
aterm.ATerm	toATerm() Returns an ATerm representation of this term.

Methods inherited from class tom.engine.adt.tomslot.TomSlotAbstractType

compareTo, compareToLPO, convertATermToBoolean, convertATermToChar, convertATermToDouble, convertATermToFloat, convertATermToInt, convertATermToLong, convertATermToString, getUniqueIdentifier, setUniqueIdentifier, symbolName, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface shared.SharedObject

duplicate, equivalent, hashCode

Methods inherited from interface tom.library.sl.Visitable

getChildAt, getChildCount, getChildren, setChildAt, setChildren

Field Detail

idConv

protected static IdConverter idConv

Constructor Detail

SlotList

protected SlotList()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

isConsconcSlot

public boolean isConsconcSlot()

Returns true if the term is rooted by the symbol ConsconcSlot

Returns:

true if the term is rooted by the symbol ConsconcSlot

isEmptyconcSlot

public boolean isEmptyconcSlot()

Returns true if the term is rooted by the symbol EmptyconcSlot

Returns:

true if the term is rooted by the symbol EmptyconcSlot

getHeadconcSlot

public Slot getHeadconcSlot()

Returns the subterm corresponding to the slot HeadconcSlot

Returns:

the subterm corresponding to the slot HeadconcSlot

setHeadconcSlot

public SlotList setHeadconcSlot(Slot _arg)

Returns a new term where the subterm corresponding to the slot HeadconcSlot is replaced by the term given in argument. Note that there is no side-effect: a new term is returned and the original term is left unchanged

Parameters:

_arg - the value of the new subterm

Returns:

a new term where the subterm corresponding to the slot HeadconcSlot is replaced by _arg

getTailconcSlot

public SlotList getTailconcSlot()

Returns the subterm corresponding to the slot TailconcSlot

Returns:

the subterm corresponding to the slot TailconcSlot

setTailconcSlot

public SlotList setTailconcSlot(SlotList _arg)

Returns a new term where the subterm corresponding to the slot TailconcSlot is replaced by the term given in argument. Note that there is no side-effect: a new term is returned and the original term is left unchanged

Parameters:

_arg - the value of the new subterm

Returns:

a new term where the subterm corresponding to the slot TailconcSlot is replaced by _arg

toATerm

public aterm.ATerm toATerm()

Returns an ATerm representation of this term.

Specified by:

toATerm in class TomSlotAbstractType

Returns:

null to indicate to sub-classes that they have to work

fromTerm

public static SlotList fromTerm(aterm.ATerm trm)

Returns a tom.engine.adt.tomslot.types.SlotList from an ATerm without any conversion

Parameters:

trm - ATerm to handle to retrieve a Gom term

Returns:

the term from the ATerm

fromString

public static SlotList fromString(String s)

Returns a tom.engine.adt.tomslot.types.SlotList from a String without any conversion

Parameters:

s - String containing the ATerm

Returns:

the term from the String

fromStream

public static SlotList fromStream(InputStream stream)
                           throws IOException

Returns a tom.engine.adt.tomslot.types.SlotList from a Stream without any conversion

Parameters:

stream - stream containing the ATerm

Returns:

the term from the Stream

Throws:

IOException - if a problem occurs with the stream

fromTerm

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

Apply a conversion on the ATerm and returns a tom.engine.adt.tomslot.types.SlotList

Parameters:

trm - ATerm to convert into a Gom term

atConv - ATermConverter used to convert the ATerm

Returns:

the Gom term

Throws:

IllegalArgumentException

fromString

public static SlotList fromString(String s,
                                  ATermConverter atConv)

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

Parameters:

s - String containing the ATerm

atConv - ATerm Converter used to convert the ATerm

Returns:

the Gom term

fromStream

public static SlotList fromStream(InputStream stream,
                                  ATermConverter atConv)
                           throws IOException

Apply a conversion on the ATerm contained in the Stream and returns a tom.engine.adt.tomslot.types.SlotList from it

Parameters:

stream - stream containing the ATerm

atConv - ATerm Converter used to convert the ATerm

Returns:

the Gom term

Throws:

IOException

length

public int length()

Returns the length of the list

Returns:

the length of the list

Throws:

IllegalArgumentException - if the term is not a list

reverse

public SlotList reverse()

Returns an inverted term

Returns:

the inverted list

Throws:

IllegalArgumentException - if the term is not a list

getCollectionconcSlot

public Collection<Slot> getCollectionconcSlot()

Returns a Collection extracted from the term

Returns:

the collection

Throws:

UnsupportedOperationException - if the term is not a list