Package io.substrait.hint

Class ImmutableHint.Builder

java.lang.Object
io.substrait.hint.ImmutableHint.Builder
Enclosing class:
ImmutableHint
public static final class ImmutableHint.Builder extends Object
Builds instances of type ImmutableHint. 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

      public final ImmutableHint.Builder from(HasExtension instance)
      Fill a builder with attribute values from the provided io.substrait.relation.HasExtension instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      public final ImmutableHint.Builder from(Hint instance)
      Fill a builder with attribute values from the provided io.substrait.hint.Hint instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • extension

      public final ImmutableHint.Builder extension(AdvancedExtension extension)
      Initializes the optional value extension to extension.
      Parameters:
      extension - The value for extension
      Returns:
      this builder for chained invocation

    • extension

      public final ImmutableHint.Builder extension(Optional<? extends AdvancedExtension> extension)
      Initializes the optional value extension to extension.
      Parameters:
      extension - The value for extension
      Returns:
      this builder for use in a chained invocation

    • alias

      public final ImmutableHint.Builder alias(String alias)
      Initializes the optional value alias to alias.
      Parameters:
      alias - The value for alias
      Returns:
      this builder for chained invocation

    • alias

      public final ImmutableHint.Builder alias(Optional<String> alias)
      Initializes the optional value alias to alias.
      Parameters:
      alias - The value for alias
      Returns:
      this builder for use in a chained invocation

    • addOutputNames

      public final ImmutableHint.Builder addOutputNames(String element)
      Adds one element to outputNames list.
      Parameters:
      element - A outputNames element
      Returns:
      this builder for use in a chained invocation

    • addOutputNames

      public final ImmutableHint.Builder addOutputNames(String... elements)
      Adds elements to outputNames list.
      Parameters:
      elements - An array of outputNames elements
      Returns:
      this builder for use in a chained invocation

    • outputNames

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

    • addAllOutputNames

      public final ImmutableHint.Builder addAllOutputNames(Iterable<String> elements)
      Adds elements to outputNames list.
      Parameters:
      elements - An iterable of outputNames elements
      Returns:
      this builder for use in a chained invocation

    • stats

      public final ImmutableHint.Builder stats(Hint.Stats stats)
      Initializes the optional value stats to stats.
      Parameters:
      stats - The value for stats
      Returns:
      this builder for chained invocation

    • stats

      public final ImmutableHint.Builder stats(Optional<? extends Hint.Stats> stats)
      Initializes the optional value stats to stats.
      Parameters:
      stats - The value for stats
      Returns:
      this builder for use in a chained invocation

    • runtimeConstraint

      public final ImmutableHint.Builder runtimeConstraint(Hint.RuntimeConstraint runtimeConstraint)
      Initializes the optional value runtimeConstraint to runtimeConstraint.
      Parameters:
      runtimeConstraint - The value for runtimeConstraint
      Returns:
      this builder for chained invocation

    • runtimeConstraint

      public final ImmutableHint.Builder runtimeConstraint(Optional<? extends Hint.RuntimeConstraint> runtimeConstraint)
      Initializes the optional value runtimeConstraint to runtimeConstraint.
      Parameters:
      runtimeConstraint - The value for runtimeConstraint
      Returns:
      this builder for use in a chained invocation

    • addLoadedComputations

      public final ImmutableHint.Builder addLoadedComputations(Hint.LoadedComputation element)
      Adds one element to loadedComputations list.
      Parameters:
      element - A loadedComputations element
      Returns:
      this builder for use in a chained invocation

    • addLoadedComputations

      public final ImmutableHint.Builder addLoadedComputations(Hint.LoadedComputation... elements)
      Adds elements to loadedComputations list.
      Parameters:
      elements - An array of loadedComputations elements
      Returns:
      this builder for use in a chained invocation

    • loadedComputations

      public final ImmutableHint.Builder loadedComputations(Iterable<? extends Hint.LoadedComputation> elements)
      Sets or replaces all elements for loadedComputations list.
      Parameters:
      elements - An iterable of loadedComputations elements
      Returns:
      this builder for use in a chained invocation

    • addAllLoadedComputations

      public final ImmutableHint.Builder addAllLoadedComputations(Iterable<? extends Hint.LoadedComputation> elements)
      Adds elements to loadedComputations list.
      Parameters:
      elements - An iterable of loadedComputations elements
      Returns:
      this builder for use in a chained invocation

    • addSavedComputations

      public final ImmutableHint.Builder addSavedComputations(Hint.SavedComputation element)
      Adds one element to savedComputations list.
      Parameters:
      element - A savedComputations element
      Returns:
      this builder for use in a chained invocation

    • addSavedComputations

      public final ImmutableHint.Builder addSavedComputations(Hint.SavedComputation... elements)
      Adds elements to savedComputations list.
      Parameters:
      elements - An array of savedComputations elements
      Returns:
      this builder for use in a chained invocation

    • savedComputations

      public final ImmutableHint.Builder savedComputations(Iterable<? extends Hint.SavedComputation> elements)
      Sets or replaces all elements for savedComputations list.
      Parameters:
      elements - An iterable of savedComputations elements
      Returns:
      this builder for use in a chained invocation

    • addAllSavedComputations

      public final ImmutableHint.Builder addAllSavedComputations(Iterable<? extends Hint.SavedComputation> elements)
      Adds elements to savedComputations list.
      Parameters:
      elements - An iterable of savedComputations elements
      Returns:
      this builder for use in a chained invocation

    • build

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