Package org.incendo.cloud.annotations.descriptor

Class ImmutableArgumentDescriptor.Builder

java.lang.Object

org.incendo.cloud.annotations.descriptor.ImmutableArgumentDescriptor.Builder

Enclosing class:

ImmutableArgumentDescriptor

public static final class ImmutableArgumentDescriptor.Builder
extends Object

Builds instances of type ImmutableArgumentDescriptor. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableArgumentDescriptor	build()	Builds a new ImmutableArgumentDescriptor.
final ImmutableArgumentDescriptor.Builder	defaultValue(@Nullable DefaultValue<?,?> defaultValue)	Initializes the value for the defaultValue attribute.
final ImmutableArgumentDescriptor.Builder	description(@Nullable Description description)	Initializes the value for the description attribute.
final ImmutableArgumentDescriptor.Builder	from(ArgumentDescriptor instance)	Fill a builder with attribute values from the provided org.incendo.cloud.annotations.descriptor.ArgumentDescriptor instance.
final ImmutableArgumentDescriptor.Builder	from(Descriptor instance)	Fill a builder with attribute values from the provided org.incendo.cloud.annotations.descriptor.Descriptor instance.
final ImmutableArgumentDescriptor.Builder	name(@NonNull String name)	Initializes the value for the name attribute.
final ImmutableArgumentDescriptor.Builder	parameter(@NonNull Parameter parameter)	Initializes the value for the parameter attribute.
final ImmutableArgumentDescriptor.Builder	parserName(@Nullable String parserName)	Initializes the value for the parserName attribute.
final ImmutableArgumentDescriptor.Builder	suggestions(@Nullable String suggestions)	Initializes the value for the suggestions attribute.

Methods inherited from class java.lang.Object

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

Method Details

from

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder from(ArgumentDescriptor instance)

Fill a builder with attribute values from the provided org.incendo.cloud.annotations.descriptor.ArgumentDescriptor instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder from(Descriptor instance)

Fill a builder with attribute values from the provided org.incendo.cloud.annotations.descriptor.Descriptor instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

parameter

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder parameter(@NonNull Parameter parameter)

Initializes the value for the parameter attribute.

Parameters:

parameter - The value for parameter

Returns:

this builder for use in a chained invocation

name

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder name(@NonNull String name)

Initializes the value for the name attribute.

Parameters:

name - The value for name

Returns:

this builder for use in a chained invocation

parserName

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder parserName(@Nullable String parserName)

Initializes the value for the parserName attribute.

Parameters:

parserName - The value for parserName (can be null)

Returns:

this builder for use in a chained invocation

suggestions

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder suggestions(@Nullable String suggestions)

Initializes the value for the suggestions attribute.

Parameters:

suggestions - The value for suggestions (can be null)

Returns:

this builder for use in a chained invocation

defaultValue

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder defaultValue(@Nullable DefaultValue<?,?> defaultValue)

Initializes the value for the defaultValue attribute.

Parameters:

defaultValue - The value for defaultValue (can be null)

Returns:

this builder for use in a chained invocation

description

@CanIgnoreReturnValue
public final ImmutableArgumentDescriptor.Builder description(@Nullable Description description)

Initializes the value for the description attribute.

Parameters:

description - The value for description (can be null)

Returns:

this builder for use in a chained invocation

build

public ImmutableArgumentDescriptor build()

Builds a new ImmutableArgumentDescriptor.

Returns:

An immutable instance of ArgumentDescriptor

Throws:

IllegalStateException - if any required attributes are missing