Package de.xima.fc.prompt.service.support

Enum EPromptConfigParamFileMultiplicity

java.lang.Object

java.lang.Enum<EPromptConfigParamFileMultiplicity>

de.xima.fc.prompt.service.support.EPromptConfigParamFileMultiplicity

All Implemented Interfaces:

Serializable, Comparable<EPromptConfigParamFileMultiplicity>

public enum EPromptConfigParamFileMultiplicity
extends Enum<EPromptConfigParamFileMultiplicity>

Enumeration that defines the multiplicity of file input parameters in a prompt query configuration, e.g. how many files are allowed. See PromptFileSetParameter.getMultiplicity().

Since:

8.5.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
ONE	1 file, e.g. a single required file.
ONE_OR_MORE	1 or more files, e.g. multiple required files.
ZERO_OR_MORE	0 or more files, e.g. multiple optional files.
ZERO_OR_ONE	0 or 1 file, e.g. a single optional file.

Method Summary

Modifier and Type	Method	Description
abstract int	max()	Gets the maximum number of files allowed for this multiplicity.
abstract int	min()	Gets the minimum number of files allowed for this multiplicity.
static EPromptConfigParamFileMultiplicity	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EPromptConfigParamFileMultiplicity[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ZERO_OR_ONE

public static final EPromptConfigParamFileMultiplicity ZERO_OR_ONE

0 or 1 file, e.g. a single optional file.

ONE

public static final EPromptConfigParamFileMultiplicity ONE

1 file, e.g. a single required file.

ONE_OR_MORE

public static final EPromptConfigParamFileMultiplicity ONE_OR_MORE

1 or more files, e.g. multiple required files.

ZERO_OR_MORE

public static final EPromptConfigParamFileMultiplicity ZERO_OR_MORE

0 or more files, e.g. multiple optional files.

Method Detail

values

public static EPromptConfigParamFileMultiplicity[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EPromptConfigParamFileMultiplicity c : EPromptConfigParamFileMultiplicity.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EPromptConfigParamFileMultiplicity valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

max

public abstract int max()

Gets the maximum number of files allowed for this multiplicity.

min

public abstract int min()

Gets the minimum number of files allowed for this multiplicity.