com.microsoft.azure.storage.blob

Class BlobRange

java.lang.Object

com.microsoft.azure.storage.blob.BlobRange

public final class BlobRange
extends Object

This is a representation of a range of bytes on a blob, typically used during a download operation. This type is immutable to ensure thread-safety of requests, so changing the values for a different operation requires construction of a new object. Passing null as a BlobRange value will default to the entire range of the blob.

Field Summary

Fields

Modifier and Type	Field and Description
static BlobRange	DEFAULT An object which reflects the service's default range, which is the whole blob.

Constructor Summary

Constructors

Constructor and Description
BlobRange()

Method Summary

Modifier and Type	Method and Description
Long	count() How many bytes to include in the range.
long	offset() The start of the range.
String	toString()
BlobRange	withCount(Long count) How many bytes to include in the range.
BlobRange	withOffset(long offset) The start of the range.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final BlobRange DEFAULT

An object which reflects the service's default range, which is the whole blob.

Constructor Detail

BlobRange

public BlobRange()

Method Detail

offset

public long offset()

The start of the range. Must be greater than or equal to 0.

withOffset

public BlobRange withOffset(long offset)

The start of the range. Must be greater than or equal to 0.

count

public Long count()

How many bytes to include in the range. Must be greater than or equal to 0 if specified.

withCount

public BlobRange withCount(Long count)

How many bytes to include in the range. Must be greater than or equal to 0 if specified.

toString

public String toString()

Overrides:

toString in class Object

Returns:

A String compliant with the format of the Azure Storage x-ms-range and Range headers.