com.anaptecs.jeaf.maven

Enum ClassOccurrencePolicy

java.lang.Object

java.lang.Enum<ClassOccurrencePolicy>

com.anaptecs.jeaf.maven.ClassOccurrencePolicy

All Implemented Interfaces:

Serializable, Comparable<ClassOccurrencePolicy>

public enum ClassOccurrencePolicy
extends Enum<ClassOccurrencePolicy>

Enumeration defines the available policies for handling cases where more than one class with an annotation was found.

Version:

JEAF Release 2.0

Author:

JEAF Development Team

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_CLASSES Use all classes.
EXACTLY_ONE_CLASS_ONLY We expect exactly one occurrence in classpath.
FIRST_CLASS Use first class that occurs in classpath, but one class is required.
ONE_CLASS_ONLY We expect one class only, but we can also live with no occurrence.

Method Summary

Modifier and Type	Method and Description
static ClassOccurrencePolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClassOccurrencePolicy[]	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

ALL_CLASSES

public static final ClassOccurrencePolicy ALL_CLASSES

Use all classes.

FIRST_CLASS

public static final ClassOccurrencePolicy FIRST_CLASS

Use first class that occurs in classpath, but one class is required.

ONE_CLASS_ONLY

public static final ClassOccurrencePolicy ONE_CLASS_ONLY

We expect one class only, but we can also live with no occurrence.

EXACTLY_ONE_CLASS_ONLY

public static final ClassOccurrencePolicy EXACTLY_ONE_CLASS_ONLY

We expect exactly one occurrence in classpath. If none or multiple where found then we ran into an error.

Method Detail

values

public static ClassOccurrencePolicy[] 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 (ClassOccurrencePolicy c : ClassOccurrencePolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClassOccurrencePolicy 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