Module technology.sola.ecs
Package technology.sola.ecs.view

Record Class View2Entry<C1 extends Component,C2 extends Component>

java.lang.Object
java.lang.Record
technology.sola.ecs.view.View2Entry<C1,C2>
Type Parameters:
C1 - the first component type
C2 - the second component type
Record Components:
entity - the Entity
c1 - the first Component instance
c2 - the second component instance
All Implemented Interfaces:
ViewEntry
@NullMarked public record View2Entry<C1 extends Component,C2 extends Component>(Entity entity, C1 extends Component c1, C2 extends Component c2) extends Record implements ViewEntry
ViewEntry implementation for View2.

  • Constructor Summary

    Constructors
    Constructor
    Description
    View2Entry(Entity entity, C1 c1, C2 c2)
    Creates an instance of a View2Entry record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    C1
    c1()
    Returns the value of the c1 record component.
    C2
    c2()
    Returns the value of the c2 record component.
    Entity
    entity()
    Returns the value of the entity 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.
    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

    • View2Entry

      public View2Entry(Entity entity, C1 c1, C2 c2)
      Creates an instance of a View2Entry record class.
      Parameters:
      entity - the value for the entity record component
      c1 - the value for the c1 record component
      c2 - the value for the c2 record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • entity

      public Entity entity()
      Returns the value of the entity record component.
      Specified by:
      entity in interface ViewEntry
      Returns:
      the value of the entity record component

    • c1

      public C1 c1()
      Returns the value of the c1 record component.
      Returns:
      the value of the c1 record component

    • c2

      public C2 c2()
      Returns the value of the c2 record component.
      Returns:
      the value of the c2 record component