FSList (Apache UIMA Java SDK: uimaj 2.10.2 API)

java.lang.Object
- org.apache.uima.cas.impl.FeatureStructureImpl
- - org.apache.uima.jcas.cas.TOP
  - - org.apache.uima.jcas.cas.FSList

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable<TOP>, FeatureStructure

Direct Known Subclasses:

EmptyFSList, NonEmptyFSList
```
public class FSList
extends TOP
implements java.lang.Iterable<TOP>
```

Field Summary

Fields
Modifier and Type Field Description

static int type

static int typeIndexID
- Fields inherited from class org.apache.uima.jcas.cas.TOP
  addr, jcasType

Constructor Summary

Constructors
Modifier Constructor Description

protected FSList()

FSList(int addr, TOP_Type type)

FSList(JCas jcas)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TOP`	`getNthElement(int i)`
`int`	`getTypeIndexID()`	used to obtain reference to the TOP_Type instance
`java.util.Iterator<TOP>`	`iterator()`
`NonEmptyFSList`	`push(TOP item)`	pushes item onto front of this list

Methods inherited from class org.apache.uima.jcas.cas.TOP
addToIndexes, addToIndexes, equals, getAddress, getCAS, getCASImpl, getLowLevelCas, hashCode, removeFromIndexes, removeFromIndexes

Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImpl
clone, getavoidcollisionTypeCode, getBooleanValue, getByteValue, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - typeIndexID
```
public static final int typeIndexID
```
  - type
```
public static final int type
```
- Constructor Detail
  - FSList
```
protected FSList()
```
  - FSList
```
public FSList(int addr,
              TOP_Type type)
```
  - FSList
```
public FSList(JCas jcas)
```
- Method Detail
  - getTypeIndexID
```
public int getTypeIndexID()
```
    Description copied from class: TOP
    
    used to obtain reference to the TOP_Type instance
    
    Overrides:
    
    getTypeIndexID in class TOP
    
    Returns:
    
    the type array index
  - getNthElement
```
public TOP getNthElement(int i)
```
  - iterator
```
public java.util.Iterator<TOP> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<TOP>
  - push
```
public NonEmptyFSList push(TOP item)
```
    pushes item onto front of this list
    
    Parameters:
    
    item - the item to push onto the list
    
    Returns:
    
    the new list, with this item as the head value of the first element