Modifier and Type	Class and Description
public abstract static class	Guard.Base
public static enum	Guard.Result

Modifier and Type	Method and Description
public Guard.Result	evaluate(FSM is the state machine causing this action. fsm, Input is the input that caused the transition. in) Called by the state engine to determine whether a transition is enabled, deferred, or disabled.

evaluate	back to summary
public Guard.Result evaluate(FSM fsm, Input in) Called by the state engine to determine whether a transition is enabled, deferred, or disabled. The result is interpreted as follows: ENABLED if the transition is ready to proceed DISABLED if the transition is not ready to proceed DEFERED if the action associated with the transition is to be deferred. This means that the input will not be acted upon, but rather it will be saved for later execution. Typically this is implemented using a CondVar wait, and the blocked thread represents the deferred input. The deferred input is retried when the thread runs again. Parameters fsm:FSM is the state machine causing this action. in:Input is the input that caused the transition.

org.glassfish.pfl.basic.fsm back to summary

public abstract Class Guard.Base

Class Inheritance

extends NameBase
implements Guard

java.lang.Object
org.glassfish.pfl.basic.fsm.NameBase
org.glassfish.pfl.basic.fsm.Guard.Base

All Implemented Interfaces

org.glassfish.pfl.basic.fsm.Guard

Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	Guard.Base.IntFunc References Deprecated `BinaryFunction` is deprecated or references (maybe indirectly) at least one deprecated element.
public abstract static class	Guard.Base.Predicate References Deprecated `BinaryPredicate` is deprecated or references (maybe indirectly) at least one deprecated element.
public abstract static class	Guard.Base.SimpleName

Constructor Summary

Access	Constructor and Description
public	Base(String name)

Method Summary

Modifier and Type	Method and Description
public static Guard.Base.Predicate	and(final Guard.Base.Predicate arg1, final Guard.Base.Predicate arg2) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element.
public static Guard.Base.IntFunc	constant(final int val) References Deprecated `Guard.Base.IntFunc` is deprecated or references (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	eq(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	ge(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	gt(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	le(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	lt(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element.
public static Guard	makeGuard(final Guard.Base.Predicate pred) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	ne(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	not(final Guard.Base.Predicate pred) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element.
public static Guard.Base.Predicate	or(final Guard.Base.Predicate arg1, final Guard.Base.Predicate arg2) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element.

Inherited from org.glassfish.pfl.basic.fsm.NameBase:: getName toString

Constructor Detail

Base	back to summary
public Base(String name)

Method Detail

and	back to summary
public static Guard.Base.Predicate and(final Guard.Base.Predicate arg1, final Guard.Base.Predicate arg2) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

constant	back to summary
public static Guard.Base.IntFunc constant(final int val) References Deprecated `Guard.Base.IntFunc` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

eq	back to summary
public static Guard.Base.Predicate eq(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

ge	back to summary
public static Guard.Base.Predicate ge(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

gt	back to summary
public static Guard.Base.Predicate gt(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

le	back to summary
public static Guard.Base.Predicate le(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

lt	back to summary
public static Guard.Base.Predicate lt(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

makeGuard	back to summary
public static Guard makeGuard(final Guard.Base.Predicate pred) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

ne	back to summary
public static Guard.Base.Predicate ne(final Guard.Base.IntFunc arg1, final Guard.Base.IntFunc arg2) References Deprecated `Guard.Base.IntFunc` and `Guard.Base.Predicate` are deprecated or reference (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

not	back to summary
public static Guard.Base.Predicate not(final Guard.Base.Predicate pred) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

or	back to summary
public static Guard.Base.Predicate or(final Guard.Base.Predicate arg1, final Guard.Base.Predicate arg2) References Deprecated `Guard.Base.Predicate` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

org.glassfish.pfl.basic.fsm back to summary

public abstract Class Guard.Base.IntFunc

Class Inheritance

extends SimpleName
implements BinaryFunction<FSM, Input, Integer>

java.lang.Object
org.glassfish.pfl.basic.fsm.Guard.Base.SimpleName
org.glassfish.pfl.basic.fsm.Guard.Base.IntFunc

All Implemented Interfaces

org.glassfish.pfl.basic.func.BinaryFunction, java.util.function.BiFunction

References Deprecated

BinaryFunction is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructor Summary

Access	Constructor and Description
public	IntFunc(String name)

Method Summary

Inherited from org.glassfish.pfl.basic.fsm.Guard.Base.SimpleName:: toString

Constructor Detail

IntFunc	back to summary
public IntFunc(String name)

org.glassfish.pfl.basic.fsm back to summary

public abstract Class Guard.Base.Predicate

Class Inheritance

extends SimpleName
implements BinaryPredicate<FSM, Input>

java.lang.Object
org.glassfish.pfl.basic.fsm.Guard.Base.SimpleName
org.glassfish.pfl.basic.fsm.Guard.Base.Predicate

All Implemented Interfaces

org.glassfish.pfl.basic.func.BinaryPredicate, java.util.function.BiPredicate

References Deprecated

BinaryPredicate is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructor Summary

Access	Constructor and Description
public	Predicate(String name)

Method Summary

Inherited from org.glassfish.pfl.basic.fsm.Guard.Base.SimpleName:: toString

Constructor Detail

Predicate	back to summary
public Predicate(String name)

org.glassfish.pfl.basic.fsm back to summary

public abstract Class Guard.Base.SimpleName

Class Inheritance

extends Object

java.lang.Object
org.glassfish.pfl.basic.fsm.Guard.Base.SimpleName

Known Direct Subclasses

org.glassfish.pfl.basic.fsm.Guard.Base.Predicate, org.glassfish.pfl.basic.fsm.Guard.Base.IntFunc

Field Summary

Modifier and Type	Field and Description
private String	name

Constructor Summary

Access	Constructor and Description
public	SimpleName(String name)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

name	back to summary
private String name

Constructor Detail

SimpleName	back to summary
public SimpleName(String name)

Method Detail

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

Modifier and Type	Method and Description
public static Guard.Result	valueOf(String name)
public static Guard.Result[]	values()

public Interface Guard

Nested and Inner Type Summary

Method Summary

Method Detail

public abstract Class Guard.Base

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public abstract Class Guard.Base.IntFunc

Constructor Summary

Method Summary

Constructor Detail

public abstract Class Guard.Base.Predicate

Constructor Summary

Method Summary

Constructor Detail

public abstract Class Guard.Base.SimpleName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Guard.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final Guard.Result	DEFERRED
public static final Guard.Result	DISABLED
public static final Guard.Result	ENABLED