Class ImmutableProtocInvocation.Builder

java.lang.Object
io.github.ascopes.protobufmavenplugin.protoc.ImmutableProtocInvocation.Builder
Enclosing class:
ImmutableProtocInvocation
@Generated(from="ProtocInvocation", generator="Immutables") public static final class ImmutableProtocInvocation.Builder extends Object
Builds instances of type ImmutableProtocInvocation. 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 ImmutableProtocInvocation.Builder from(ProtocInvocation instance)
      Fill a builder with attribute values from the provided ProtocInvocation instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • protocPath

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

    • fatalWarnings

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

    • addArguments

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addArguments(@Nullable String element)
      Adds one element to arguments list.
      Parameters:
      element - A arguments element
      Returns:
      this builder for use in a chained invocation

    • addArguments

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addArguments(@Nullable String... elements)
      Adds elements to arguments list.
      Parameters:
      elements - An array of arguments elements
      Returns:
      this builder for use in a chained invocation

    • arguments

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder arguments(Iterable<@Nullable String> elements)
      Sets or replaces all elements for arguments list.
      Parameters:
      elements - An iterable of arguments elements
      Returns:
      this builder for use in a chained invocation

    • addAllArguments

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addAllArguments(Iterable<@Nullable String> elements)
      Adds elements to arguments list.
      Parameters:
      elements - An iterable of arguments elements
      Returns:
      this builder for use in a chained invocation

    • putEnvironmentVariables

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder putEnvironmentVariables(@Nullable String key, @Nullable String value)
      Put one entry to the environmentVariables map.
      Parameters:
      key - The key in the environmentVariables map
      value - The associated value in the environmentVariables map
      Returns:
      this builder for use in a chained invocation

    • putEnvironmentVariables

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder putEnvironmentVariables(Map.Entry<@Nullable String, ? extends @Nullable String> entry)
      Put one entry to the environmentVariables map. Nulls are not permitted
      Parameters:
      entry - The key and value entry
      Returns:
      this builder for use in a chained invocation

    • environmentVariables

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder environmentVariables(Map<@Nullable String, ? extends @Nullable String> entries)
      Sets or replaces all mappings from the specified map as entries for the environmentVariables map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the environmentVariables map
      Returns:
      this builder for use in a chained invocation

    • putAllEnvironmentVariables

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder putAllEnvironmentVariables(Map<@Nullable String, ? extends @Nullable String> entries)
      Put all mappings from the specified map as entries to environmentVariables map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the environmentVariables map
      Returns:
      this builder for use in a chained invocation

    • addImportPaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addImportPaths(@Nullable Path element)
      Adds one element to importPaths list.
      Parameters:
      element - A importPaths element
      Returns:
      this builder for use in a chained invocation

    • addImportPaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addImportPaths(@Nullable Path... elements)
      Adds elements to importPaths list.
      Parameters:
      elements - An array of importPaths elements
      Returns:
      this builder for use in a chained invocation

    • importPaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder importPaths(Iterable<? extends @Nullable Path> elements)
      Sets or replaces all elements for importPaths list.
      Parameters:
      elements - An iterable of importPaths elements
      Returns:
      this builder for use in a chained invocation

    • addAllImportPaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addAllImportPaths(Iterable<? extends @Nullable Path> elements)
      Adds elements to importPaths list.
      Parameters:
      elements - An iterable of importPaths elements
      Returns:
      this builder for use in a chained invocation

    • addInputDescriptorFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addInputDescriptorFiles(@Nullable Path element)
      Adds one element to inputDescriptorFiles list.
      Parameters:
      element - A inputDescriptorFiles element
      Returns:
      this builder for use in a chained invocation

    • addInputDescriptorFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addInputDescriptorFiles(@Nullable Path... elements)
      Adds elements to inputDescriptorFiles list.
      Parameters:
      elements - An array of inputDescriptorFiles elements
      Returns:
      this builder for use in a chained invocation

    • inputDescriptorFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder inputDescriptorFiles(Iterable<? extends @Nullable Path> elements)
      Sets or replaces all elements for inputDescriptorFiles list.
      Parameters:
      elements - An iterable of inputDescriptorFiles elements
      Returns:
      this builder for use in a chained invocation

    • addAllInputDescriptorFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addAllInputDescriptorFiles(Iterable<? extends @Nullable Path> elements)
      Adds elements to inputDescriptorFiles list.
      Parameters:
      elements - An iterable of inputDescriptorFiles elements
      Returns:
      this builder for use in a chained invocation

    • addDescriptorSourceFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addDescriptorSourceFiles(@Nullable String element)
      Adds one element to descriptorSourceFiles list.
      Parameters:
      element - A descriptorSourceFiles element
      Returns:
      this builder for use in a chained invocation

    • addDescriptorSourceFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addDescriptorSourceFiles(@Nullable String... elements)
      Adds elements to descriptorSourceFiles list.
      Parameters:
      elements - An array of descriptorSourceFiles elements
      Returns:
      this builder for use in a chained invocation

    • descriptorSourceFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder descriptorSourceFiles(Iterable<@Nullable String> elements)
      Sets or replaces all elements for descriptorSourceFiles list.
      Parameters:
      elements - An iterable of descriptorSourceFiles elements
      Returns:
      this builder for use in a chained invocation

    • addAllDescriptorSourceFiles

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addAllDescriptorSourceFiles(Iterable<@Nullable String> elements)
      Adds elements to descriptorSourceFiles list.
      Parameters:
      elements - An iterable of descriptorSourceFiles elements
      Returns:
      this builder for use in a chained invocation

    • addSourcePaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addSourcePaths(@Nullable Path element)
      Adds one element to sourcePaths list.
      Parameters:
      element - A sourcePaths element
      Returns:
      this builder for use in a chained invocation

    • addSourcePaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addSourcePaths(@Nullable Path... elements)
      Adds elements to sourcePaths list.
      Parameters:
      elements - An array of sourcePaths elements
      Returns:
      this builder for use in a chained invocation

    • sourcePaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder sourcePaths(Iterable<? extends @Nullable Path> elements)
      Sets or replaces all elements for sourcePaths list.
      Parameters:
      elements - An iterable of sourcePaths elements
      Returns:
      this builder for use in a chained invocation

    • addAllSourcePaths

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder addAllSourcePaths(Iterable<? extends @Nullable Path> elements)
      Adds elements to sourcePaths list.
      Parameters:
      elements - An iterable of sourcePaths elements
      Returns:
      this builder for use in a chained invocation

    • targets

      @CanIgnoreReturnValue public final ImmutableProtocInvocation.Builder targets(SortedSet<ProtocTarget> targets)
      Initializes the value for the targets attribute.
      Parameters:
      targets - The value for targets (can be null)
      Returns:
      this builder for use in a chained invocation

    • sanctionedExecutablePath

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

    • build

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