Package cloud.commandframework.captions

Class SimpleCaptionRegistry<C>

java.lang.Object

cloud.commandframework.captions.SimpleCaptionRegistry<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

CaptionRegistry<C>, FactoryDelegatingCaptionRegistry<C>

@API(status=STABLE)
public class SimpleCaptionRegistry<C>
extends Object
implements FactoryDelegatingCaptionRegistry<C>

Caption registry that uses bi-functions to produce messages

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGUMENT_PARSE_FAILURE_BOOLEAN	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_BOOLEAN.
static final String	ARGUMENT_PARSE_FAILURE_CHAR	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_CHAR
static final String	ARGUMENT_PARSE_FAILURE_COLOR	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_COLOR
static final String	ARGUMENT_PARSE_FAILURE_DURATION	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_DURATION
static final String	ARGUMENT_PARSE_FAILURE_ENUM	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_ENUM
static final String	ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG
static final String	ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT
static final String	ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED
static final String	ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION
static final String	ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG
static final String	ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED.
static final String	ARGUMENT_PARSE_FAILURE_NUMBER	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_NUMBER
static final String	ARGUMENT_PARSE_FAILURE_REGEX	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX
static final String	ARGUMENT_PARSE_FAILURE_STRING	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_STRING
static final String	ARGUMENT_PARSE_FAILURE_UUID	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_UUID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleCaptionRegistry()

Method Summary

Modifier and Type	Method	Description
final @NonNull String	getCaption(@NonNull Caption caption, @NonNull C sender)	Get a caption for a specific sender
final void	registerMessageFactory(@NonNull Caption caption, @NonNull BiFunction<Caption,C,String> messageFactory)	Register a message factory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED

public static final String ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_NO_INPUT_PROVIDED.

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_BOOLEAN

public static final String ARGUMENT_PARSE_FAILURE_BOOLEAN

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_BOOLEAN.

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_NUMBER

public static final String ARGUMENT_PARSE_FAILURE_NUMBER

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_NUMBER

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_CHAR

public static final String ARGUMENT_PARSE_FAILURE_CHAR

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_CHAR

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_ENUM

public static final String ARGUMENT_PARSE_FAILURE_ENUM

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_ENUM

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_STRING

public static final String ARGUMENT_PARSE_FAILURE_STRING

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_STRING

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_UUID

public static final String ARGUMENT_PARSE_FAILURE_UUID

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_UUID

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_REGEX

public static final String ARGUMENT_PARSE_FAILURE_REGEX

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_REGEX

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG

public static final String ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_UNKNOWN_FLAG

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG

public static final String ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_DUPLICATE_FLAG

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED

public static final String ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_NO_FLAG_STARTED

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT

public static final String ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_MISSING_ARGUMENT

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION

public static final String ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_FLAG_NO_PERMISSION

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_COLOR

public static final String ARGUMENT_PARSE_FAILURE_COLOR

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_COLOR

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_DURATION

public static final String ARGUMENT_PARSE_FAILURE_DURATION

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_DURATION

See Also:

• Constant Field Values

Constructor Details

SimpleCaptionRegistry

protected SimpleCaptionRegistry()

Method Details

getCaption

public final @NonNull String getCaption(@NonNull Caption caption,
 @NonNull C sender)

Description copied from interface: CaptionRegistry

Get a caption for a specific sender

Specified by:

getCaption in interface CaptionRegistry<C>

Parameters:

caption - Caption key

sender - Sender

Returns:

Caption

registerMessageFactory

public final void registerMessageFactory(@NonNull Caption caption,
 @NonNull BiFunction<Caption,C,String> messageFactory)

Description copied from interface: FactoryDelegatingCaptionRegistry

Register a message factory

Specified by:

registerMessageFactory in interface FactoryDelegatingCaptionRegistry<C>

Parameters:

caption - Caption key

messageFactory - Message factory