Record Class UcumTerm.Factor

java.lang.Object
java.lang.Record
network.ike.foundation.ike.ucum.UcumTerm.Factor
Record Components:
prefix - the prefix's code, empty when none
atom - the atom's code
exponent - the exponent, one when none was written
Enclosing class:
UcumTerm

public static record UcumTerm.Factor(String prefix, String atom, int exponent) extends Record
One factor of a unit: a prefix, empty when none, an atom, and an exponent.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Factor(String prefix, String atom, int exponent)
    Creates an instance of a Factor record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the atom record component.
    The factor's code: prefix, atom, and the exponent when not one.
    final boolean
    Indicates whether some other object is "equal to" this one.
    int
    Returns the value of the exponent record component.
    final int
    Returns a hash code value for this object.
    Returns the value of the prefix record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Factor

      public Factor(String prefix, String atom, int exponent)
      Creates an instance of a Factor record class.
      Parameters:
      prefix - the value for the prefix record component
      atom - the value for the atom record component
      exponent - the value for the exponent record component
  • Method Details

    • code

      public String code()
      The factor's code: prefix, atom, and the exponent when not one.
      Returns:
      the code
    • 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 the compare method from their corresponding wrapper classes.
      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.
    • prefix

      public String prefix()
      Returns the value of the prefix record component.
      Returns:
      the value of the prefix record component
    • atom

      public String atom()
      Returns the value of the atom record component.
      Returns:
      the value of the atom record component
    • exponent

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