Package ca.stellardrift.permissionsex.context

Class SimpleContextDefinition

java.lang.Object

ca.stellardrift.permissionsex.context.ContextDefinition<String>

ca.stellardrift.permissionsex.context.SimpleContextDefinition

Direct Known Subclasses:

SimpleContextDefinition.Fallback

public class SimpleContextDefinition
extends ContextDefinition<String>

Context definition for types that have no complex data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleContextDefinition.Fallback

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleContextDefinition(String name)

Method Summary

Modifier and Type	Method	Description
void	accumulateCurrentValues(CalculatedSubject subject, Consumer<String> consumer)	Given a player, calculate active context types
static SimpleContextDefinition	context(String name, BiConsumer<CalculatedSubject,Consumer<String>> valueAccumulator)	Create a basic context definition with the provided key and accumulation function.
String	deserialize(String userValue)	Given a string (which may be in user format), return a parsed object.
boolean	matches(String ownVal, String testVal)
String	serialize(String canonicalValue)	Given a parsed value, write data out as a string.

Methods inherited from class ca.stellardrift.permissionsex.context.ContextDefinition

createValue, equals, hashCode, matches, name, suggestValues, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleContextDefinition

protected SimpleContextDefinition(String name)

Method Detail

context

public static SimpleContextDefinition context(String name,
                                              BiConsumer<CalculatedSubject,Consumer<String>> valueAccumulator)

Create a basic context definition with the provided key and accumulation function.

Parameters:

name - context name

valueAccumulator - a callback taking a subject and a value accumulator

Returns:

a new context definition

See Also:

to add this context to an engine.

accumulateCurrentValues

public void accumulateCurrentValues(CalculatedSubject subject,
                                    Consumer<String> consumer)

Description copied from class: ContextDefinition

Given a player, calculate active context types

Specified by:

accumulateCurrentValues in class ContextDefinition<String>

Parameters:

subject - The subject active contexts are being calculated for

consumer - A function that will take the returned value and add it to the active context set

matches

public boolean matches(String ownVal,
                       String testVal)

Specified by:

matches in class ContextDefinition<String>

serialize

public String serialize(String canonicalValue)

Description copied from class: ContextDefinition

Given a parsed value, write data out as a string.

Specified by:

serialize in class ContextDefinition<String>

Parameters:

canonicalValue - Parsed value

Returns:

serialized form of the value

deserialize

public String deserialize(String userValue)

Description copied from class: ContextDefinition

Given a string (which may be in user format), return a parsed object.

Specified by:

deserialize in class ContextDefinition<String>

Parameters:

userValue - the value as a string, such as when provided by user input

Returns:

V a deserialized value, or null if unsuccessful