Package dev.sympho.modular_commands.utils.builder

Class ParameterBuilder<T extends @NonNull Object>

java.lang.Object

dev.sympho.modular_commands.utils.builder.ParameterBuilder<T>

Type Parameters:

T - The type of value received by the parameter.

public final class ParameterBuilder<T extends @NonNull Object>
extends Object

Base for a parameter builder.

Since:

1.0

Version:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable T	defaultValue	The default parameter value.
protected @MonotonicNonNull @MatchesRegex("(?Us)^.{1,100}+$") String	description	The parameter description.
protected @MonotonicNonNull @MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String	name	The parameter name.
protected @MonotonicNonNull ArgumentParser<?,T>	parser	The parser to use for processing.
protected boolean	required	Whether the parameter is required.

Constructor Summary

Constructors

Constructor	Description
ParameterBuilder()	Constructs a new builder with default values.
ParameterBuilder(ParameterBuilder<T> base)	Constructs a new builder that is a copy of the given builder.

Method Summary

Modifier and Type	Method	Description
Parameter<T>	build()	Builds the configured parameter.
boolean	equals(@Nullable Object o)	Indicates whether the given object is a builder of the same type and configuration as this one.
static <T extends @NonNull Object> ParameterBuilder<T>	from(Parameter<T> base)	Constructs a new builder that is initialized to make a copy of the given parameter.
int	hashCode()
ParameterBuilder<T>	withDefault(@Nullable T defaultValue)	Sets the default value of the parameter to build.
ParameterBuilder<T>	withDescription(@MatchesRegex("(?Us)^.{1,100}+$") String description)	Sets the description of the parameter to build.
ParameterBuilder<T>	withName(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)	Sets the name of the parameter to build.
ParameterBuilder<T>	withParser(ArgumentParser<?,T> parser)	Sets the parser to process arguments with.
ParameterBuilder<T>	withRequired(boolean required)	Sets the required flag of the parameter to build.

Methods inherited from class java.lang.Object

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

Field Details

name

protected @MonotonicNonNull @MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name

The parameter name.

description

protected @MonotonicNonNull @MatchesRegex("(?Us)^.{1,100}+$") String description

The parameter description.

required

protected boolean required

Whether the parameter is required.

defaultValue

protected @Nullable T extends @NonNull Object defaultValue

The default parameter value.

parser

protected @MonotonicNonNull ArgumentParser<?,T extends @NonNull Object> parser

The parser to use for processing.

Constructor Details

ParameterBuilder

@Pure
public ParameterBuilder()

Constructs a new builder with default values.

ParameterBuilder

@SideEffectFree
public ParameterBuilder(ParameterBuilder<T> base)

Constructs a new builder that is a copy of the given builder.

Parameters:

base - The builder to copy.

Method Details

from

@SideEffectFree
public static <T extends @NonNull Object>
ParameterBuilder<T> from(Parameter<T> base)
                  throws IllegalArgumentException

Constructs a new builder that is initialized to make a copy of the given parameter.

Type Parameters:

T - The argument type.

Parameters:

base - The parameter to copy.

Returns:

The initialized builder.

Throws:

IllegalArgumentException - if the given parameter has invalid values.

withName

@Deterministic
public ParameterBuilder<T> withName(@MatchesRegex("(?U)^[-_\\p{L}\\p{N}\\p{sc=Deva}\\p{sc=Thai}]{1,32}+$") String name)
                             throws IllegalArgumentException

Sets the name of the parameter to build.

Parameters:

name - The parameter name.

Returns:

This builder.

Throws:

IllegalArgumentException - if the given name is invalid.

See Also:

• Parameter.name()

withDescription

@Deterministic
public ParameterBuilder<T> withDescription(@MatchesRegex("(?Us)^.{1,100}+$") String description)
                                    throws IllegalArgumentException

Sets the description of the parameter to build.

Parameters:

description - The parameter description.

Returns:

This builder.

Throws:

IllegalArgumentException - if the given name is invalid.

See Also:

• Parameter.description()

withRequired

@Deterministic
public ParameterBuilder<T> withRequired(boolean required)

Sets the required flag of the parameter to build.

Parameters:

required - The required flag.

Returns:

This builder.

See Also:

• Parameter.required()

withDefault

@Deterministic
public ParameterBuilder<T> withDefault(@Nullable T defaultValue)

Sets the default value of the parameter to build.

Parameters:

defaultValue - The default value.

Returns:

This builder.

See Also:

• Parameter.defaultValue()

withParser

@Deterministic
public ParameterBuilder<T> withParser(ArgumentParser<?,T> parser)

Sets the parser to process arguments with.

Parameters:

parser - The parser to use.

Returns:

This builder.

See Also:

• Parameter.parser()

build

@SideEffectFree
public Parameter<T> build(ParameterBuilder<T extends @NonNull Object> this)
                   throws IllegalStateException

Builds the configured parameter.

Returns:

The built parameter.

Throws:

IllegalStateException - if the current configuration is invalid.

equals

public boolean equals(@Nullable Object o)

Indicates whether the given object is a builder of the same type and configuration as this one.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object