InclusiveByteRange (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.klomp.snark.web.InclusiveByteRange

public class InclusiveByteRange
extends Object

Byte range inclusive of end points.


   parses the following types of byte ranges:

       bytes=100-499
       bytes=-300
       bytes=100-
       bytes=1-2,2-3,6-,-2

   given an entity length, converts range to string

       bytes 100-499/500

Based on RFC2616 3.12, 14.16, 14.35.1, 14.35.2

Version:: $version$

Field Summary
Fields
Modifier and Type Field and Description
(package private) long first
The first byte position
(package private) long last
The last byte position

Fields
Modifier and Type	Field and Description
`(package private) long`	`first` The first byte position
`(package private) long`	`last` The last byte position

Constructor Summary
Constructors
Constructor and Description
InclusiveByteRange(long first, long last)
Creates a new byte range.

Constructors
Constructor and Description
`InclusiveByteRange(long first, long last)` Creates a new byte range.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`getFirst()` Returns the first byte position in this range.
`long`	`getFirst(long size)` Returns the first byte position, resolved against the total entity size.
`long`	`getLast()` Returns the last byte position in this range.
`long`	`getLast(long size)` Returns the last byte position, resolved against the total entity size.
`long`	`getSize(long size)` Returns the number of bytes in this range, resolved against the total entity size.
`static List<InclusiveByteRange>`	`satisfiableRanges(Enumeration<?> headers, long size)`
`static String`	`to416HeaderRangeString(long size)` Formats a 416 Range Not Satisfiable response header value.
`String`	`toHeaderRangeString(long size)` Formats this range as an HTTP Content-Range header value.
`String`	`toString()` Returns a string representation of this range in the form `first:last`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - first
```
long first
```
    The first byte position
  - last
```
long last
```
    The last byte position
- Constructor Detail
  - InclusiveByteRange
```
public InclusiveByteRange(long first,
                          long last)
```
    Creates a new byte range.
    Parameters:
    first - the first byte in the range (inclusive), or negative for suffix ranges
    last - the last byte in the range (inclusive), or negative for suffix ranges
- Method Detail
  - getFirst
```
public long getFirst()
```
    Returns the first byte position in this range.
    Returns:
    the first byte position (may be negative for suffix ranges)
  - getFirst
```
public long getFirst(long size)
```
    Returns the first byte position, resolved against the total entity size. For suffix ranges (negative first), returns max(0, size - last).
    Parameters:
    size - the total size of the entity
    Returns:
    the resolved first byte position
  - getLast
```
public long getLast()
```
    Returns the last byte position in this range.
    Returns:
    the last byte position (may be negative for suffix ranges)
  - getLast
```
public long getLast(long size)
```
    Returns the last byte position, resolved against the total entity size. Clamps to size - 1 for open-ended or out-of-bounds ranges.
    Parameters:
    size - the total size of the entity
    Returns:
    the resolved last byte position
  - getSize
```
public long getSize(long size)
```
    Returns the number of bytes in this range, resolved against the total entity size.
    Parameters:
    size - the total size of the entity
    Returns:
    the number of bytes in the range (always >= 1)
  - satisfiableRanges
```
public static List<InclusiveByteRange> satisfiableRanges(Enumeration<?> headers,
                                                         long size)
```
    Parameters:
    headers - Enumeration of Range header fields.
    size - Size of the resource.
    Returns:
    List of satisfiable ranges
  - to416HeaderRangeString
```
public static String to416HeaderRangeString(long size)
```
    Formats a 416 Range Not Satisfiable response header value. Returns a string of the form "bytes star/star-size".
    Parameters:
    size - the total size of the entity
    Returns:
    the Content-Range header value for a 416 response
  - toHeaderRangeString
```
public String toHeaderRangeString(long size)
```
    Formats this range as an HTTP Content-Range header value. Returns a string of the form bytes first-last/size.
    Parameters:
    size - the total size of the entity
    Returns:
    the Content-Range header value
  - toString
```
public String toString()
```
    Returns a string representation of this range in the form first:last.
    Overrides:
    toString in class Object
    Returns:
    string representation of this range

Class InclusiveByteRange

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

first

last

Constructor Detail

InclusiveByteRange

Method Detail

getFirst

getFirst

getLast

getLast

getSize

satisfiableRanges

to416HeaderRangeString

toHeaderRangeString

toString