Package org.dellroad.msrp.msg

Class ByteRange

java.lang.Object

org.dellroad.msrp.msg.ByteRange

public class ByteRange
extends Object

MSRP Byte-Range header value.

Instances are immutable.

Field Summary

Fields

Modifier and Type	Field	Description
static ByteRange	ALL	Used for indeterminate "all" byte range: 1-*/*.
static ByteRange	EMPTY	Used for empty messages: 1-0/0.

Constructor Summary

Constructors

Constructor	Description
ByteRange(long total)	Constructs an instance indicating the entire content with the specified length.
ByteRange(long start, long end, long total)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ByteRange	fromString(String string)	Create an instance by parsing a String.
long	getEnd()	Get the end byte position.
long	getStart()	Get the start byte position.
long	getTotal()	Get the total number of bytes.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY

public static final ByteRange EMPTY

Used for empty messages: 1-0/0.

ALL

public static final ByteRange ALL

Used for indeterminate "all" byte range: 1-*/*.

Constructor Detail

ByteRange

public ByteRange(long total)

Constructs an instance indicating the entire content with the specified length. Equivalent to ByteRange(1, total, total).

Parameters:

total - total number of bytes, or -1 if unspecified

Throws:

IllegalArgumentException - if total is less than -1

ByteRange

public ByteRange(long start,
                 long end,
                 long total)

Constructor.

Parameters:

start - start byte position (1-based)

end - end byte position (1-based), or -1 if unspecified

total - total number of bytes, or -1 if unspecified

Throws:

IllegalArgumentException - if start is less than 1

IllegalArgumentException - if end or total is less than -1

IllegalArgumentException - if end is not -1 and start - 1 is greater than end

IllegalArgumentException - if total is not -1 and end is greater than total

Method Detail

getStart

public long getStart()

Get the start byte position.

Returns:

start byte position, at least one

getEnd

public long getEnd()

Get the end byte position.

Returns:

end byte position, or -1 if not specified

getTotal

public long getTotal()

Get the total number of bytes.

Returns:

total number of bytes, or -1 if not specified

fromString

public static ByteRange fromString(String string)

Create an instance by parsing a String.

Parameters:

string - byte range expressed as a string

Returns:

corresponding ByteRange

Throws:

IllegalArgumentException - if string is null or invalid

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object