Package org.apache.uima.collection.metadata

Interface CasProcessorExecArgs

All Superinterfaces:

Serializable

All Known Implementing Classes:

CasProcessorExecArgsImpl

public interface CasProcessorExecArgs
extends Serializable

An object containing all CasProcessorExecArg instances. It provides the means of adding new program arguments, retrieving them, and removing them.

Method Summary

Modifier and Type	Method	Description
void	add(CasProcessorExecArg aArg)	Adds new CasProcessorExecArg instance to the list.
CasProcessorExecArg	get(int aIndex)	Returns an CasProcessorExecArg instance located with provided index.
CasProcessorExecArg[]	getAll()	Returns ALL CasProcessorExecArg instances.
void	remove(int aIndex)	Removes CasProcessorExecArg instance found in the list in a given position.

Method Details

add

void add(CasProcessorExecArg aArg)

Adds new CasProcessorExecArg instance to the list.

Parameters:

aArg - - new argument

get

CasProcessorExecArg get(int aIndex)
                 throws CpeDescriptorException

Returns an CasProcessorExecArg instance located with provided index.

Parameters:

aIndex - - position of argument in the list

Returns:

- CasProcessorExecArg instance

Throws:

CpeDescriptorException - tbd

getAll

CasProcessorExecArg[] getAll()

Returns ALL CasProcessorExecArg instances.

Returns:

array of CasProcessorExecArg

remove

void remove(int aIndex)

Removes CasProcessorExecArg instance found in the list in a given position.

Parameters:

aIndex - - position of argument to remove.