Package org.apache.uima.cas
Interface BooleanArrayFS
-
- All Superinterfaces:
CommonArrayFS
,FeatureStructure
- All Known Implementing Classes:
BooleanArray
,BooleanArrayFSImpl
public interface BooleanArrayFS extends CommonArrayFS
Boolean array interface. To create a boolean array object, useCAS.createBooleanArrayFS()
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
copyFromArray(boolean[] src, int srcOffset, int destOffset, int length)
Copy the contents of an external array into this array.void
copyToArray(int srcOffset, boolean[] dest, int destOffset, int length)
Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.boolean
get(int i)
Get the i-th string from the array.void
set(int i, boolean b)
Set the i-th value.boolean[]
toArray()
Create a Java array that is a copy of the internal CAS array.-
Methods inherited from interface org.apache.uima.cas.CommonArrayFS
copyFromArray, copyToArray, size, 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 Detail
-
get
boolean get(int i) throws ArrayIndexOutOfBoundsException
Get the i-th string from the array.- Parameters:
i
- selects the string- Returns:
- The i-th element.
- Throws:
ArrayIndexOutOfBoundsException
- If the index is out of bounds.
-
set
void set(int i, boolean b) throws ArrayIndexOutOfBoundsException
Set the i-th value.- Parameters:
i
- The index.b
- The value.- Throws:
ArrayIndexOutOfBoundsException
- Ifi
is out of bounds.
-
toArray
boolean[] toArray()
Create a Java array that is a copy of the internal CAS array.- Returns:
- An array copy.
-
copyToArray
void copyToArray(int srcOffset, boolean[] dest, int destOffset, int length) throws ArrayIndexOutOfBoundsException
Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.- 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(boolean[] src, int srcOffset, int destOffset, int length) throws ArrayIndexOutOfBoundsException
Copy the contents of an external array into this array.- 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
-
-