Package io.substrait.relation

Class ImmutableExtensionSingle

java.lang.Object
io.substrait.relation.AbstractRel
io.substrait.relation.SingleInputRel
io.substrait.relation.ExtensionSingle
io.substrait.relation.ImmutableExtensionSingle
All Implemented Interfaces:
Rel
public final class ImmutableExtensionSingle extends ExtensionSingle
Immutable implementation of ExtensionSingle.

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

  • Method Details

    • 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

    • getHint

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

    • deriveRecordType

      protected Type.Struct deriveRecordType()
      Specified by:
      deriveRecordType in class AbstractRel
      Returns:
      The value of the deriveRecordType attribute

    • getInput

      public Rel getInput()
      Specified by:
      getInput in class SingleInputRel
      Returns:
      The value of the input attribute

    • getDetail

      public Extension.SingleRelDetail getDetail()
      Specified by:
      getDetail in class ExtensionSingle
      Returns:
      The value of the detail attribute

    • withRemap

      public final ImmutableExtensionSingle 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 ImmutableExtensionSingle 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 ImmutableExtensionSingle 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 ImmutableExtensionSingle 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

    • withHint

      public final ImmutableExtensionSingle 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 ImmutableExtensionSingle 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

    • withDeriveRecordType

      public final ImmutableExtensionSingle withDeriveRecordType(Type.Struct value)
      Copy the current immutable object by setting a value for the deriveRecordType attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for deriveRecordType
      Returns:
      A modified copy or the this object

    • withInput

      public final ImmutableExtensionSingle withInput(Rel value)
      Copy the current immutable object by setting a value for the input attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for input
      Returns:
      A modified copy or the this object

    • withDetail

      public final ImmutableExtensionSingle withDetail(Extension.SingleRelDetail value)
      Copy the current immutable object by setting a value for the detail attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for detail
      Returns:
      A modified copy or the this object

    • equals

      public boolean equals(Object another)
      This instance is equal to all instances of ImmutableExtensionSingle 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: remap, commonExtension, hint, deriveRecordType, input, detail.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableExtensionSingle copyOf(ExtensionSingle instance)
      Creates an immutable copy of a ExtensionSingle 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 ExtensionSingle instance

    • builder

      public static ImmutableExtensionSingle.Builder builder()
      Creates a builder for ImmutableExtensionSingle. 
       ImmutableExtensionSingle.builder()
    .remap(Optional<io.substrait.relation.Rel.Remap>) // optional remap
    .commonExtension(Optional<io.substrait.extension.AdvancedExtension>) // optional commonExtension
    .hint(Optional<io.substrait.hint.Hint>) // optional hint
    .deriveRecordType(io.substrait.type.Type.Struct) // required deriveRecordType
    .input(io.substrait.relation.Rel) // required input
    .detail(io.substrait.relation.Extension.SingleRelDetail) // required detail
    .build();
      Returns:
      A new ImmutableExtensionSingle builder