Package org.apache.uima.cas
Interface StringArrayFS
- All Superinterfaces:
CommonArrayFS
,FeatureStructure
- All Known Implementing Classes:
StringArray
,StringArrayFSImpl
String array interface. To create a string array object, use
CAS.createStringArrayFS()
.-
Method Summary
Modifier and TypeMethodDescriptionvoid
copyFromArray
(String[] src, int srcOffset, int destOffset, int length) Copy the contents of an external array into this array.void
copyToArray
(int srcOffset, String[] dest, int destOffset, int length) Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.get
(int i) Get the i-th string from the array.void
Set the i-th value.int
size()
Return the size of the array.String[]
toArray()
Creates a new array the this array is copied to.Methods inherited from interface org.apache.uima.cas.CommonArrayFS
toStringArray
Methods inherited from interface org.apache.uima.cas.FeatureStructure
clone, equals, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue
-
Method Details
-
size
int size()Return the size of the array.- Specified by:
size
in interfaceCommonArrayFS
- Returns:
- The size of the array.
-
get
Get the i-th string from the array.- Parameters:
i
- the index- Returns:
- The i-th element.
- Throws:
ArrayIndexOutOfBoundsException
- If the index is out of bounds.
-
set
Set the i-th value.- Parameters:
i
- The index.str
- The value.- Throws:
ArrayIndexOutOfBoundsException
- Ifi
is out of bounds.
-
copyToArray
void copyToArray(int srcOffset, String[] dest, int destOffset, int length) throws ArrayIndexOutOfBoundsException Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.- Specified by:
copyToArray
in interfaceCommonArrayFS
- Parameters:
srcOffset
- The index of the first element to copy.dest
- The array to copy to.destOffset
- Where to start copying intodest
.length
- The number of elements to copy.- Throws:
ArrayIndexOutOfBoundsException
- IfsrcOffset < 0
orlength > size()
ordestOffset + length > destArray.length
.
-
copyFromArray
void copyFromArray(String[] src, int srcOffset, int destOffset, int length) throws ArrayIndexOutOfBoundsException Copy the contents of an external array into this array.- Specified by:
copyFromArray
in interfaceCommonArrayFS
- Parameters:
src
- The source array.srcOffset
- Where to start copying in the source array.destOffset
- Where to start copying to in the destination array.length
- The number of elements to copy.- Throws:
ArrayIndexOutOfBoundsException
- When length conditions are not met.
-
toArray
String[] toArray()Creates a new array the this array is copied to.- Returns:
- A Java array copy of this FS array.
-