org.apache.uima.cas
Interface ByteArrayFS

All Superinterfaces:

CommonArrayFS, FeatureStructure

All Known Implementing Classes:

ByteArray

public interface ByteArrayFS
extends CommonArrayFS

Byte array interface. To create a byte array object, use CAS.createByteArrayFS().

Method Summary

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

byte get(int i)
         throws ArrayIndexOutOfBoundsException

Get the i-th string from the array.

Returns:

The i-th element.

Throws:

ArrayIndexOutOfBoundsException - If the index is out of bounds.

set

void set(int i,
         byte str)
         throws ArrayIndexOutOfBoundsException

Set the i-th value.

Parameters:

i - The index.

str - The value.

Throws:

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 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:

ArrayIndexOutOfBoundsException - If srcOffset < 0 or length > size() or destOffset + 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