org.javaswift.joss.headers.object.range

Class AbstractRange

java.lang.Object

org.javaswift.joss.headers.Header

org.javaswift.joss.headers.object.range.AbstractRange

Direct Known Subclasses:

ExcludeStartRange, FirstPartRange, LastPartRange, MidPartRange

public abstract class AbstractRange
extends Header

Offers the option to return not the entire object, but only a designated part. The various options are

• ExcludeStartRange - take the object starting from position x until the end
• FirstPartRange - take the first x bytes of the object, starting at position 0
• MidPartRange - take the object from offset for a certain length
• LastPartRange - take the last x bytes, starting at the end minus x until the end

Also see: http://docs.openstack.org/api/openstack-object-storage/1.0/content/retrieve-object.html

Field Summary

Fields

Modifier and Type	Field and Description
protected long	length
protected long	offset
java.lang.String	RANGE_HEADER_NAME
java.lang.String	RANGE_HEADER_VALUE_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRange(long offset, long length)

Method Summary

Modifier and Type	Method and Description
byte[]	copy(byte[] original)
abstract long	getFrom(int byteArrayLength)
java.lang.String	getHeaderName() Returns the header name that must be set in the request.
java.lang.String	getHeaderValue() Returns the value that must be set in the request.
abstract long	getTo(int byteArrayLength)

Methods inherited from class org.javaswift.joss.headers.Header

convertResponseHeader, getResponseHeadersStartingWith, headerNotEmpty, setHeader

Methods inherited from class java.lang.Object

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

Field Detail

RANGE_HEADER_NAME

public java.lang.String RANGE_HEADER_NAME

RANGE_HEADER_VALUE_PREFIX

public java.lang.String RANGE_HEADER_VALUE_PREFIX

offset

protected long offset

length

protected long length

Constructor Detail

AbstractRange

protected AbstractRange(long offset,
                        long length)

Method Detail

getHeaderValue

public java.lang.String getHeaderValue()

Description copied from class: Header

Returns the value that must be set in the request. Eg, "bytes: 4-12"

Specified by:

getHeaderValue in class Header

Returns:

the value for the request header

getHeaderName

public java.lang.String getHeaderName()

Description copied from class: Header

Returns the header name that must be set in the request. Eg, "Range"

Specified by:

getHeaderName in class Header

Returns:

the name for the request header

getFrom

public abstract long getFrom(int byteArrayLength)

getTo

public abstract long getTo(int byteArrayLength)

copy

public byte[] copy(byte[] original)