Package ch.tocco.nice2.validate.api

Enum Class RunOn

java.lang.Object

java.lang.Enum<RunOn>

ch.tocco.nice2.validate.api.RunOn

All Implemented Interfaces:

Serializable, Comparable<RunOn>, Constable

public enum RunOn
extends Enum<RunOn>

Where to run a validator.

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
ALL	Validators that are run on both the CLIENT and the SERVER.
CLIENT	Validators that are only run on the CLIENT.
SERVER	Validators that are only run on the SERVER.

Method Summary

Modifier and Type	Method	Description
abstract boolean	mismatches(RunOn other)	Tells if two RunOn levels completely don't work together.
boolean	runOnClient()
boolean	runOnServer()
static RunOn	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RunOn[]	values()	Returns an array containing the constants of this enum class, 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

CLIENT

public static final RunOn CLIENT

Validators that are only run on the CLIENT.

SERVER

public static final RunOn SERVER

Validators that are only run on the SERVER.

ALL

public static final RunOn ALL

Validators that are run on both the CLIENT and the SERVER.

Method Details

values

public static RunOn[] values()

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

Returns:

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

valueOf

public static RunOn valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

runOnClient

public boolean runOnClient()

runOnServer

public boolean runOnServer()

mismatches

public abstract boolean mismatches(RunOn other)

Tells if two RunOn levels completely don't work together. 'SERVER' vs. 'CLIENT' never works. 'SERVER' vs. 'ALL' is fine.

Parameters:

other - The RunOn value to compare

Returns:

True if they mismatch completely.