net.sf.magicproject.event.phase
Enum PhaseFilter

java.lang.Object
  java.lang.Enum<PhaseFilter>
      net.sf.magicproject.event.phase.PhaseFilter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PhaseFilter>

public enum PhaseFilter
extends java.lang.Enum<PhaseFilter>

Since:

0.83

Author:

Fabrice Daugan

Enum Constant Summary

ID_PHASE_FILTER
This code is used to do a test on phase's identifiant

INDEX_PHASE_FILTER
This code is used to do a test on phase's index

Method Summary

int	getPhaseFilter() Return the identifiant or the index of current phase.
void	setNextPhase(int idPhase) Set the identifiant or the index of next phase.
static PhaseFilter	valueOf(java.io.InputStream input) Read and return the enum from the given inputstream.
static PhaseFilter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PhaseFilter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	write(java.io.OutputStream out) Wrtite this enum to the given outputstream.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INDEX_PHASE_FILTER

public static final PhaseFilter INDEX_PHASE_FILTER

This code is used to do a test on phase's index

ID_PHASE_FILTER

public static final PhaseFilter ID_PHASE_FILTER

This code is used to do a test on phase's identifiant

Method Detail

values

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

Returns:

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

valueOf

public static PhaseFilter valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getPhaseFilter

public int getPhaseFilter()

Return the identifiant or the index of current phase.

Returns:

the identifiant or the index of current phase.

setNextPhase

public void setNextPhase(int idPhase)

Set the identifiant or the index of next phase.

Parameters:

idPhase - the identifiant or the index of next phase.

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Wrtite this enum to the given outputstream.

Parameters:

out - the stream ths enum would be written.

Throws:

java.io.IOException - error while writting event's id

valueOf

public static PhaseFilter valueOf(java.io.InputStream input)
                           throws java.io.IOException

Read and return the enum from the given inputstream.

Parameters:

input - the stream containing the enum to read.

Returns:

the enum from the given inputstream.

Throws:

java.io.IOException - error while reading event's id.