Package org.incendo.cloud.annotations.descriptor

Class ImmutableFlagDescriptor.Builder

java.lang.Object
org.incendo.cloud.annotations.descriptor.ImmutableFlagDescriptor.Builder
Enclosing class:
ImmutableFlagDescriptor
@Generated(from="FlagDescriptor", generator="Immutables") public static final class ImmutableFlagDescriptor.Builder extends Object
Builds instances of type ImmutableFlagDescriptor. 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 Details

    • from

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.Builder from(FlagDescriptor instance)
      Fill a builder with attribute values from the provided org.incendo.cloud.annotations.descriptor.FlagDescriptor instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.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 ImmutableFlagDescriptor.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 ImmutableFlagDescriptor.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

    • aliases

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.Builder aliases(@NonNull Collection<String> aliases)
      Initializes the value for the aliases attribute.
      Parameters:
      aliases - The value for aliases
      Returns:
      this builder for use in a chained invocation

    • parserName

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.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 ImmutableFlagDescriptor.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

    • permission

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.Builder permission(@Nullable Permission permission)
      Initializes the value for the permission attribute.
      Parameters:
      permission - The value for permission (can be null)
      Returns:
      this builder for use in a chained invocation

    • description

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.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

    • repeatable

      @CanIgnoreReturnValue public final ImmutableFlagDescriptor.Builder repeatable(boolean repeatable)
      Initializes the value for the repeatable attribute.
      Parameters:
      repeatable - The value for repeatable
      Returns:
      this builder for use in a chained invocation

    • build

      public ImmutableFlagDescriptor build()
      Builds a new ImmutableFlagDescriptor.
      Returns:
      An immutable instance of FlagDescriptor
      Throws:
      IllegalStateException - if any required attributes are missing