Package io.github.ocelot.glslprocessor.api.node

Record Class GlslTree.GlslBlock

java.lang.Object
java.lang.Record
io.github.ocelot.glslprocessor.api.node.GlslTree.GlslBlock
Record Components:
body - The body the node is inside
index - The index inside the body the node is listed
Enclosing class:
GlslTree
public static record GlslTree.GlslBlock(GlslNodeList body, int index) extends Record
Holds data about what block nodes are contained inside of.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlslBlock(GlslNodeList body, int index)
    Creates an instance of a GlslBlock record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    GlslNodeList
    body()
    Returns the value of the body record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    index()
    Returns the value of the index record component.
    GlslNodeList
    list()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use body() instead.
    GlslNode
    node()
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GlslBlock

      public GlslBlock(GlslNodeList body, int index)
      Creates an instance of a GlslBlock record class.
      Parameters:
      body - the value for the body record component
      index - the value for the index record component

  • Method Details

    • node

      public GlslNode node()
      Returns:
      The original node

    • list

      @Deprecated(forRemoval=true, since="0.1.0") public GlslNodeList list()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use body() instead. Will be removed in 0.2.0
      Returns:
      The body the node is inside

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • body

      public GlslNodeList body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component

    • index

      public int index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component