Package net.datafaker.service

Record Class Range<T extends Comparable<T>>

java.lang.Object
java.lang.Record
net.datafaker.service.Range<T>
public record Range<T extends Comparable<T>>(Range.Bound<T extends Comparable<T>> from, Range.Bound<T extends Comparable<T>> to) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    Range.Bound<T>
     
    static enum 
    Range.End
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Range(Range.Bound<T> from, Range.Bound<T> to)
    Creates an instance of a Range record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    <V extends Comparable<V>>
    Range<V>
    cast(Function<T,V> caster)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static <T extends Number & Comparable<T>>
    Range<T>
    exclusive(T from, T to)
    A range that contains all values 1. strictly greater than from, and 2. strictly less than to.
    static <T extends Comparable<T>>
    Range<T>
    exclusiveInclusive(T from, T to)
    A range that contains all values 1. strictly greater than from, and 2. less than or equal to to.
    Range.Bound<T>
    from()
    Returns the value of the from record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static <T extends Comparable<T>>
    Range<T>
    inclusive(T from, T to)
    A range that contains all values 1. greater than or equal to from, and 2. less than or equal to to.
    static <T extends Comparable<T>>
    Range<T>
    inclusiveExclusive(T from, T to)
    A range that contains all values 1. greater than or equal to from, and 2. less than to.
    Range.Bound<T>
    to()
    Returns the value of the to record component.
    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

    • Range

      public Range(Range.Bound<T> from, Range.Bound<T> to)
      Creates an instance of a Range record class.
      Parameters:
      from - the value for the from record component
      to - the value for the to record component

  • Method Details

    • inclusive

      public static <T extends Comparable<T>> Range<T> inclusive(T from, T to)
      A range that contains all values 1. greater than or equal to from, and 2. less than or equal to to.

    • inclusiveExclusive

      public static <T extends Comparable<T>> Range<T> inclusiveExclusive(T from, T to)
      A range that contains all values 1. greater than or equal to from, and 2. less than to.

    • exclusive

      public static <T extends Number & Comparable<T>> Range<T> exclusive(T from, T to)
      A range that contains all values 1. strictly greater than from, and 2. strictly less than to.

    • exclusiveInclusive

      public static <T extends Comparable<T>> Range<T> exclusiveInclusive(T from, T to)
      A range that contains all values 1. strictly greater than from, and 2. less than or equal to to.

    • cast

      public <V extends Comparable<V>> Range<V> cast(Function<T,V> caster)

    • 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.

    • from

      public Range.Bound<T> from()
      Returns the value of the from record component.
      Returns:
      the value of the from record component

    • to

      public Range.Bound<T> to()
      Returns the value of the to record component.
      Returns:
      the value of the to record component