Package org.apache.juneau.http.header

Class ContentRange.Builder

java.lang.Object

org.apache.juneau.http.header.ContentRange.Builder

Enclosing class:

ContentRange

public static class ContentRange.Builder
extends Object

Fluent builder for assembling an HTTP Content-Range header value.

Composes the three fields defined by RFC 7233 §4.2 — the range unit (default bytes), the resolved first-last byte range (or * for an unsatisfied range), and the complete-length (or * when unknown) — into forms such as bytes 0-1023/2048, bytes 0-1023/*, and bytes */2048.

Example:

String value = ContentRange.create() .range(0, 1023) .length(2048) .build(); // => "bytes 0-1023/2048"

See Also:

• ContentRange
• RFC 7233 - HTTP/1.1 Range Requests

Since:

10.0.0

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
String	build()	Builds the rendered Content-Range header value.
ContentRange.Builder	length(long value)	Sets the complete-length (the total size of the representation).
ContentRange.Builder	range(long startValue, long endValue)	Sets the resolved first-last byte range.
ContentRange	toHeader()	Builds a ContentRange header bean directly from this builder.
String	toString()
ContentRange.Builder	unit(String value)	Sets the range unit (default bytes).
ContentRange.Builder	unknownLength()	Marks the complete length as unknown, rendering it as *.
ContentRange.Builder	unsatisfiedRange()	Marks the range portion as unsatisfied, rendering it as * (used with a known complete length).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

unit

public ContentRange.Builder unit(String value)

Sets the range unit (default bytes).

Parameters:

value - The range unit. Must not be null or blank.

Returns:

This object.

Throws:

IllegalArgumentException - If value is null or blank.

range

public ContentRange.Builder range(long startValue,
 long endValue)

Sets the resolved first-last byte range.

Clears any previously-set unsatisfied marker.

Parameters:

startValue - The first byte position (inclusive). Must be non-negative.

endValue - The last byte position (inclusive). Must be greater than or equal to startValue.

Returns:

This object.

Throws:

IllegalArgumentException - If the positions are negative or out of order.

unsatisfiedRange

public ContentRange.Builder unsatisfiedRange()

Marks the range portion as unsatisfied, rendering it as * (used with a known complete length).

Returns:

This object.

length

public ContentRange.Builder length(long value)

Sets the complete-length (the total size of the representation).

Clears any previously-set unknown-length marker.

Parameters:

value - The complete length in units. Must be non-negative.

Returns:

This object.

Throws:

IllegalArgumentException - If value is negative.

unknownLength

public ContentRange.Builder unknownLength()

Marks the complete length as unknown, rendering it as *.

Returns:

This object.

build

public String build()

Builds the rendered Content-Range header value.

Returns:

The header value. Never null.

toHeader

public ContentRange toHeader()

Builds a ContentRange header bean directly from this builder.

Returns:

A ContentRange carrying build(). Never null.

toString

public String toString()

Overrides:

toString in class Object