net.sourceforge.javadpkg.field

Enum FieldType

java.lang.Object

java.lang.Enum<FieldType>

net.sourceforge.javadpkg.field.FieldType

All Implemented Interfaces:

Serializable, Comparable<FieldType>

public enum FieldType
extends Enum<FieldType>

The type of a field.

Version:

1.0, 28.04.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANDATORY A mandatory field.
OPTIONAL An optional field.
RECOMMENDED A recommended field.

Method Summary

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

MANDATORY

public static final FieldType MANDATORY

A mandatory field.

If the field is not present an exception will be thrown.

RECOMMENDED

public static final FieldType RECOMMENDED

A recommended field.

If the field is not present a warning will be added to the context.

OPTIONAL

public static final FieldType OPTIONAL

An optional field.

If the field is not present it will be ignored.

Method Detail

values

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

Returns:

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

valueOf

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