Package org.apache.uima.cas

Interface StringArrayFS

All Superinterfaces:

java.lang.Cloneable, CommonArrayFS<java.lang.String>, FeatureStructure

All Known Subinterfaces:

StringArrayFSImpl

All Known Implementing Classes:

StringArray

public interface StringArrayFS
extends CommonArrayFS<java.lang.String>

String array interface. To create a string array object, use CAS.createStringArrayFS(int) or new StringArray(aJCas, length)

Method Summary

Modifier and Type	Method	Description
java.lang.String	get(int i)	Get the i-th string from the array.
void	set(int i, java.lang.String str)	Set the i-th value.
java.lang.String[]	toArray()	Creates a new array the this array is copied to.

Methods inherited from interface org.apache.uima.cas.CommonArrayFS

copyFromArray, copyToArray, copyValuesFrom, getValuesAsCommaSeparatedString, isEmpty, size, toStringArray

Methods inherited from interface org.apache.uima.cas.FeatureStructure

_getTypeCode, _id, clone, equals, getAddress, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getJCas, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue

Method Detail

get

java.lang.String get(int i)
              throws java.lang.ArrayIndexOutOfBoundsException

Get the i-th string from the array.

Parameters:

i - the index

Returns:

The i-th element.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the index is out of bounds.

set

void set(int i,
         java.lang.String str)
  throws java.lang.ArrayIndexOutOfBoundsException

Set the i-th value.

Parameters:

i - The index.

str - The value.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If i is out of bounds.

toArray

java.lang.String[] toArray()

Creates a new array the this array is copied to.

Returns:

A Java array copy of this FS array.