Package org.incendo.cloud.caption

Class StandardCaptionsProvider<C>

java.lang.Object

org.incendo.cloud.caption.DelegatingCaptionProvider<C>

org.incendo.cloud.caption.StandardCaptionsProvider<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

CaptionProvider<C>

@API(status=STABLE)
public final class StandardCaptionsProvider<C>
extends DelegatingCaptionProvider<C>

Provides default captions for all StandardCaptionKeys.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE
static final String	ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT
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_EITHER	Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_EITHER
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_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
static final String	EXCEPTION_INVALID_ARGUMENT	Default caption for StandardCaptionKeys.EXCEPTION_INVALID_ARGUMENT
static final String	EXCEPTION_INVALID_SENDER	Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SENDER
static final String	EXCEPTION_INVALID_SENDER_LIST	Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SENDER_LIST
static final String	EXCEPTION_INVALID_SYNTAX	Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SYNTAX
static final String	EXCEPTION_NO_PERMISSION	Default caption for StandardCaptionKeys.EXCEPTION_NO_PERMISSION
static final String	EXCEPTION_NO_SUCH_COMMAND	Default caption for StandardCaptionKeys.EXCEPTION_NO_SUCH_COMMAND
static final String	EXCEPTION_UNEXPECTED	Default caption for StandardCaptionKeys.EXCEPTION_UNEXPECTED

Constructor Summary

Constructors

Constructor	Description
StandardCaptionsProvider()

Method Summary

Modifier and Type	Method	Description
@NonNull CaptionProvider<C>	delegate()	Returns the provider to delegate to.

Methods inherited from class org.incendo.cloud.caption.DelegatingCaptionProvider

provide

Methods inherited from class java.lang.Object

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

Field Details

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

ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT

public static final String ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_AGGREGATE_MISSING_INPUT

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE

public static final String ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_AGGREGATE_COMPONENT_FAILURE

See Also:

• Constant Field Values

ARGUMENT_PARSE_FAILURE_EITHER

public static final String ARGUMENT_PARSE_FAILURE_EITHER

Default caption for StandardCaptionKeys.ARGUMENT_PARSE_FAILURE_EITHER

See Also:

• Constant Field Values

EXCEPTION_UNEXPECTED

public static final String EXCEPTION_UNEXPECTED

Default caption for StandardCaptionKeys.EXCEPTION_UNEXPECTED

See Also:

• Constant Field Values

EXCEPTION_INVALID_ARGUMENT

public static final String EXCEPTION_INVALID_ARGUMENT

Default caption for StandardCaptionKeys.EXCEPTION_INVALID_ARGUMENT

See Also:

• Constant Field Values

EXCEPTION_NO_SUCH_COMMAND

public static final String EXCEPTION_NO_SUCH_COMMAND

Default caption for StandardCaptionKeys.EXCEPTION_NO_SUCH_COMMAND

See Also:

• Constant Field Values

EXCEPTION_NO_PERMISSION

public static final String EXCEPTION_NO_PERMISSION

Default caption for StandardCaptionKeys.EXCEPTION_NO_PERMISSION

See Also:

• Constant Field Values

EXCEPTION_INVALID_SENDER

public static final String EXCEPTION_INVALID_SENDER

Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SENDER

See Also:

• Constant Field Values

EXCEPTION_INVALID_SENDER_LIST

public static final String EXCEPTION_INVALID_SENDER_LIST

Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SENDER_LIST

See Also:

• Constant Field Values

EXCEPTION_INVALID_SYNTAX

public static final String EXCEPTION_INVALID_SYNTAX

Default caption for StandardCaptionKeys.EXCEPTION_INVALID_SYNTAX

See Also:

• Constant Field Values

Constructor Details

StandardCaptionsProvider

public StandardCaptionsProvider()

Method Details

delegate

public @NonNull CaptionProvider<C> delegate()

Description copied from class: DelegatingCaptionProvider

Returns the provider to delegate to.

Specified by:

delegate in class DelegatingCaptionProvider<C>

Returns:

delegate provider