org.openstack4j.model.common.header

Class Range

java.lang.Object

org.openstack4j.model.common.header.Range

All Implemented Interfaces:

HeaderOption

public class Range
extends Object
implements HeaderOption

A Range is used to get portions of data by using one or more range specifications.

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
static Range	first(long maxBytes) Return only bytes starting from 0 to maxBytes of data
static Range	from(long offset, long lastByte) Return bytes only from offset in bytes to the specified lastByte
static Range	last(long lastBytes) Return only the last N bytes of data
static Range	startAt(long offset) Return all bytes after the specified offset of data
HeaderNameValue	toHeader() Transform the option into a Header
String	value()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

last

public static Range last(long lastBytes)

Return only the last N bytes of data

Parameters:

lastBytes - the last N bytes to return

Returns:

the range object

first

public static Range first(long maxBytes)

Return only bytes starting from 0 to maxBytes of data

Parameters:

maxBytes - the max bytes to download

Returns:

the range object

startAt

public static Range startAt(long offset)

Return all bytes after the specified offset of data

Parameters:

offset - the starting pointer

Returns:

the range object

from

public static Range from(long offset,
                         long lastByte)

Return bytes only from offset in bytes to the specified lastByte

Parameters:

offset - the starting pointer

lastByte - the last byte

Returns:

the range object

toHeader

public HeaderNameValue toHeader()

Description copied from interface: HeaderOption

Transform the option into a Header

Specified by:

toHeader in interface HeaderOption

Returns:

the header name value object

value

public String value()