revxrsal.commands.node

Class DispatcherSettings<A extends CommandActor>

java.lang.Object

revxrsal.commands.node.DispatcherSettings<A>

Type Parameters:

A - The actor type

public final class DispatcherSettings<A extends CommandActor>
extends java.lang.Object

Contains the settings for Lamp's underlying dispatcher. This can be used to customize Lamp's behavior for finding and dealing with failed Potentials that occur by trying out the same input on several commands.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DispatcherSettings.Builder<A extends CommandActor> Builder class for DispatcherSettings

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_FAILED_ATTEMPTS The default number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the FailureHandler.
static java.lang.String	LONG_FORMAT_PREFIX The default long format for flags and switches
static java.lang.String	SHORT_FORMAT_PREFIX The default short format for flags and switches

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> @NotNull DispatcherSettings.Builder<A>	builder() Creates a new DispatcherSettings.Builder for constructing DispatcherSettings
@NotNull FailureHandler<A>	failureHandler() The failure handler that will consume the failed potentials.
int	maximumFailedAttempts() The number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the failureHandler().
@NotNull StackTraceSanitizer	stackTraceSanitizer() The stack trace sanitizer for cleaning up stack-traces of errors thrown inside commands
@NotNull DispatcherSettings.Builder<A>	toBuilder() Creates a new DispatcherSettings.Builder based on this DispatcherSettings instance

Methods inherited from class java.lang.Object

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

Field Detail

LONG_FORMAT_PREFIX

public static final java.lang.String LONG_FORMAT_PREFIX

The default long format for flags and switches

See Also:

Constant Field Values

SHORT_FORMAT_PREFIX

public static final java.lang.String SHORT_FORMAT_PREFIX

The default short format for flags and switches

See Also:

Constant Field Values

DEFAULT_MAXIMUM_FAILED_ATTEMPTS

public static final int DEFAULT_MAXIMUM_FAILED_ATTEMPTS

The default number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the FailureHandler.

See Also:

Constant Field Values

Method Detail

builder

@NotNull
public static <A extends CommandActor> @NotNull DispatcherSettings.Builder<A> builder()

Creates a new DispatcherSettings.Builder for constructing DispatcherSettings

Type Parameters:

A - The actor type

Returns:

The newly created builder

maximumFailedAttempts

public int maximumFailedAttempts()

The number of failed attempts after which Lamp will stop testing out commands (for efficiency) and invoke the failureHandler().

Returns:

the maximum number of failed attempts

failureHandler

@NotNull
public @NotNull FailureHandler<A> failureHandler()

The failure handler that will consume the failed potentials.

Returns:

the failure handler

stackTraceSanitizer

@NotNull
public @NotNull StackTraceSanitizer stackTraceSanitizer()

The stack trace sanitizer for cleaning up stack-traces of errors thrown inside commands

Returns:

The sanitizer

toBuilder

@Contract(value="-> new",
          pure=true)
 @NotNull
public @NotNull DispatcherSettings.Builder<A> toBuilder()

Creates a new DispatcherSettings.Builder based on this DispatcherSettings instance

Returns:

The newly created builder