Package org.apache.uima.cas

Interface ByteArrayFS

All Superinterfaces:

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

All Known Subinterfaces:

ByteArrayFSImpl

All Known Implementing Classes:

ByteArray

public interface ByteArrayFS
extends CommonArrayFS<java.lang.Byte>

Byte array interface. To create a byte array object, use CAS.createByteArrayFS(int) or new ByteArray(aJCas, length)

Method Summary

Modifier and Type	Method	Description
void	copyFromArray(byte[] src, int srcOffset, int destOffset, int length)	Copy the contents of an external array into this array.
void	copyToArray(int srcOffset, byte[] dest, int destOffset, int length)	Copy the contents of the array from start to end to the destination destArray with destination offset destOffset.
byte	get(int i)	Get the i-th string from the array.
void	set(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, 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

byte 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,
         byte 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

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 java.lang.ArrayIndexOutOfBoundsException

Copy the contents of the array from start to end to the destination destArray with destination offset destOffset.

Parameters:

srcOffset - The index of the first element to copy.

dest - The array to copy to.

destOffset - Where to start copying into dest.

length - The number of elements to copy.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If srcOffset < 0 or length > size() or destOffset + length > destArray.length.

copyFromArray

void copyFromArray(byte[] src,
                   int srcOffset,
                   int destOffset,
                   int length)
            throws java.lang.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:

java.lang.ArrayIndexOutOfBoundsException