Package org.attoparser.config

Enum ParseConfiguration.PrologPresence

java.lang.Object

java.lang.Enum<ParseConfiguration.PrologPresence>

org.attoparser.config.ParseConfiguration.PrologPresence

All Implemented Interfaces:

Serializable, Comparable<ParseConfiguration.PrologPresence>, java.lang.constant.Constable

Enclosing class:

ParseConfiguration

public static enum ParseConfiguration.PrologPresence
extends Enum<ParseConfiguration.PrologPresence>

Enumeration used for determining whether an element in the document prolog (DOCTYPE, XML Declaration) or the prolog itself should be allowed, required or even forbidden.

This enumeration is used at the ParseConfiguration class.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOWED
FORBIDDEN
REQUIRED

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowed
private final boolean	forbidden
private final boolean	required

Constructor Summary

Constructors

Modifier	Constructor	Description
private	PrologPresence(boolean required, boolean allowed, boolean forbidden)

Method Summary

Modifier and Type	Method	Description
boolean	isAllowed()
boolean	isForbidden()
boolean	isRequired()
static ParseConfiguration.PrologPresence	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ParseConfiguration.PrologPresence[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final ParseConfiguration.PrologPresence REQUIRED

ALLOWED

public static final ParseConfiguration.PrologPresence ALLOWED

FORBIDDEN

public static final ParseConfiguration.PrologPresence FORBIDDEN

Field Details

required

private final boolean required

allowed

private final boolean allowed

forbidden

private final boolean forbidden

Constructor Details

PrologPresence

private PrologPresence(boolean required,
 boolean allowed,
 boolean forbidden)

Method Details

values

public static ParseConfiguration.PrologPresence[] values()

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

Returns:

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

valueOf

public static ParseConfiguration.PrologPresence 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

isRequired

public boolean isRequired()

isAllowed

public boolean isAllowed()

isForbidden

public boolean isForbidden()