Package org.apache.uima.cas
Interface ByteArrayFS
- All Superinterfaces:
Cloneable,CommonArrayFS<Byte>,FeatureStructure
- All Known Subinterfaces:
ByteArrayFSImpl
- All Known Implementing Classes:
ByteArray
Byte array interface. To create a byte array object, use
CAS.createByteArrayFS(int) or new
ByteArray(aJCas, length)-
Method Summary
Modifier and TypeMethodDescriptionvoidcopyFromArray(byte[] src, int srcOffset, int destOffset, int length) Copy the contents of an external array into this array.voidcopyToArray(int srcOffset, byte[] dest, int destOffset, int length) Copy the contents of the array fromstarttoendto the destinationdestArraywith destination offsetdestOffset.byteget(int i) Get the i-th string from the array.voidset(int i, byte str) Set the i-th value.byte[]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, copyValuesFrom, getValuesAsCommaSeparatedString, isEmpty, size, toStringArrayMethods 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 Details
-
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- Ifiis out of bounds.
-
toArray
byte[] toArray()Create a Java array that is a copy of the internal CAS array.- Returns:
- An array copy.
-
copyToArray
void copyToArray(int srcOffset, byte[] dest, int destOffset, int length) throws ArrayIndexOutOfBoundsException Copy the contents of the array fromstarttoendto the destinationdestArraywith 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 < 0orlength > size()ordestOffset + length > destArray.length.
-
copyFromArray
void copyFromArray(byte[] 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
-