Package io.substrait.relation

Class ImmutableSet

java.lang.Object
io.substrait.relation.AbstractRel
io.substrait.relation.Set
io.substrait.relation.ImmutableSet
All Implemented Interfaces:
HasExtension, Rel
public final class ImmutableSet extends Set
Immutable implementation of Set.

Use the builder to create immutable instances: ImmutableSet.builder().

  • Method Details

    • getExtension

      public Optional<AdvancedExtension> getExtension()
      Returns:
      the AdvancedExtension associated directly with the class

    • getRemap

      public Optional<Rel.Remap> getRemap()
      Returns:
      The value of the remap attribute

    • getCommonExtension

      public Optional<AdvancedExtension> getCommonExtension()
      Returns:
      the AdvancedExtension associated with a RelCommon message, if present

    • getInputs

      public List<Rel> getInputs()
      Returns:
      The value of the inputs attribute

    • getHint

      public Optional<Hint> getHint()
      Returns:
      The value of the hint attribute

    • getSetOp

      public Set.SetOp getSetOp()
      Specified by:
      getSetOp in class Set
      Returns:
      The value of the setOp attribute

    • withExtension

      public final ImmutableSet withExtension(AdvancedExtension value)
      Copy the current immutable object by setting a present value for the optional extension attribute.
      Parameters:
      value - The value for extension
      Returns:
      A modified copy or this if not changed

    • withExtension

      public final ImmutableSet withExtension(Optional<? extends AdvancedExtension> optional)
      Copy the current immutable object by setting an optional value for the extension attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for extension
      Returns:
      A modified copy or this if not changed

    • withRemap

      public final ImmutableSet withRemap(Rel.Remap value)
      Copy the current immutable object by setting a present value for the optional remap attribute.
      Parameters:
      value - The value for remap
      Returns:
      A modified copy or this if not changed

    • withRemap

      public final ImmutableSet withRemap(Optional<? extends Rel.Remap> optional)
      Copy the current immutable object by setting an optional value for the remap attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for remap
      Returns:
      A modified copy or this if not changed

    • withCommonExtension

      public final ImmutableSet withCommonExtension(AdvancedExtension value)
      Copy the current immutable object by setting a present value for the optional commonExtension attribute.
      Parameters:
      value - The value for commonExtension
      Returns:
      A modified copy or this if not changed

    • withCommonExtension

      public final ImmutableSet withCommonExtension(Optional<? extends AdvancedExtension> optional)
      Copy the current immutable object by setting an optional value for the commonExtension attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for commonExtension
      Returns:
      A modified copy or this if not changed

    • withInputs

      public final ImmutableSet withInputs(Rel... elements)
      Copy the current immutable object with elements that replace the content of inputs.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withInputs

      public final ImmutableSet withInputs(Iterable<? extends Rel> elements)
      Copy the current immutable object with elements that replace the content of inputs. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of inputs elements to set
      Returns:
      A modified copy or this if not changed

    • withHint

      public final ImmutableSet withHint(Hint value)
      Copy the current immutable object by setting a present value for the optional hint attribute.
      Parameters:
      value - The value for hint
      Returns:
      A modified copy or this if not changed

    • withHint

      public final ImmutableSet withHint(Optional<? extends Hint> optional)
      Copy the current immutable object by setting an optional value for the hint attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - An optional value for hint
      Returns:
      A modified copy or this if not changed

    • withSetOp

      public final ImmutableSet withSetOp(Set.SetOp value)
      Copy the current immutable object by setting a value for the setOp attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for setOp
      Returns:
      A modified copy or the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of ImmutableSet that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: extension, remap, commonExtension, inputs, hint, setOp.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value Set with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableSet copyOf(Set instance)
      Creates an immutable copy of a Set value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
      Parameters:
      instance - The instance to copy
      Returns:
      A copied immutable Set instance

    • builder

      public static ImmutableSet.Builder builder()
      Creates a builder for ImmutableSet. 
       ImmutableSet.builder()
    .extension(Optional<io.substrait.extension.AdvancedExtension>) // optional extension
    .remap(Optional<io.substrait.relation.Rel.Remap>) // optional remap
    .commonExtension(Optional<io.substrait.extension.AdvancedExtension>) // optional commonExtension
    .addInputs|addAllInputs(io.substrait.relation.Rel) // inputs elements
    .hint(Optional<io.substrait.hint.Hint>) // optional hint
    .setOp(io.substrait.relation.Set.SetOp) // required setOp
    .build();
      Returns:
      A new ImmutableSet builder