org.chocosolver.solver.variables.events

Enum PropagatorEventType

java.lang.Object

java.lang.Enum<PropagatorEventType>

org.chocosolver.solver.variables.events.PropagatorEventType

All Implemented Interfaces:

Serializable, Comparable<PropagatorEventType>, IEventType

public enum PropagatorEventType
extends Enum<PropagatorEventType>
implements IEventType

An enum defining the propagator event types:

• FULL_PROPAGATION: Propagation from scratch (as in initial propagation),
• CUSTOM_PROPAGATION: custom propagation triggered by the developer (partially incremental propagation)

Author:

Charles Prud'homme, Jean-Guillaume Fages

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM_PROPAGATION
FULL_PROPAGATION
VOID

Field Summary

Fields inherited from interface org.chocosolver.solver.variables.events.IEventType

ALL_EVENTS

Method Summary

Modifier and Type	Method and Description
int	getMask() Return the value of the mask associated with the event.
static boolean	isCustomPropagation(int mask)
static boolean	isFullPropagation(int mask)
static PropagatorEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PropagatorEventType[]	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

VOID

public static final PropagatorEventType VOID

CUSTOM_PROPAGATION

public static final PropagatorEventType CUSTOM_PROPAGATION

FULL_PROPAGATION

public static final PropagatorEventType FULL_PROPAGATION

Method Detail

values

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

Returns:

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

valueOf

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

getMask

public int getMask()

Description copied from interface: IEventType

Return the value of the mask associated with the event.

Specified by:

getMask in interface IEventType

Returns:

the mask of the event.

isFullPropagation

public static boolean isFullPropagation(int mask)

isCustomPropagation

public static boolean isCustomPropagation(int mask)