Package rife.engine

Record Class ByteRange

java.lang.Object
java.lang.Record
rife.engine.ByteRange
Record Components:
start - the position of the first byte
end - the position of the last byte, inclusive

public record ByteRange(long start, long end) extends Record
A single byte range of a Range request header, resolved against the length of the content it applies to.
Since:
1.11.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ByteRange
    The result of parsing a range that the content can't satisfy, which should be answered with a 416 status.
  • Constructor Summary

    Constructors
    Constructor
    Description
    ByteRange(long start, long end)
    Creates an instance of a ByteRange record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    end()
    Returns the value of the end record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    long
    Retrieves the number of bytes in this range.
    static ByteRange
    parse(String header, long length)
    Parses the value of a Range request header.
    long
    Returns the value of the start record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

    • UNSATISFIABLE

      public static final ByteRange UNSATISFIABLE
      The result of parsing a range that the content can't satisfy, which should be answered with a 416 status. Compare a parsed range to it with ==.
      Since:
      1.11.0
  • Constructor Details

    • ByteRange

      public ByteRange(long start, long end)
      Creates an instance of a ByteRange record class.
      Parameters:
      start - the value for the start record component
      end - the value for the end record component
  • Method Details

    • parse

      public static ByteRange parse(String header, long length)
      Parses the value of a Range request header.

      Only a single range of bytes is supported, for anything else null is returned so that the whole content can be served, as HTTP allows.

      Parameters:
      header - the value of the Range header
      length - the length of the content in bytes
      Returns:
      the requested range;

      UNSATISFIABLE if the content can't satisfy it; or

      null if the whole content should be served

      Since:
      1.11.0
    • length

      public long length()
      Retrieves the number of bytes in this range.
      Returns:
      the length of this range
      Since:
      1.11.0
    • 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 '=='.
      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.
    • start

      public long start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component
    • end

      public long end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component