com.emc.esu.api

Class Extent

java.lang.Object

com.emc.esu.api.Extent

Direct Known Subclasses:

MultiExtent

public class Extent
extends java.lang.Object

An extent specifies a portion of an object to read or write. It contains a starting offset and a number of bytes to read or write.

Field Summary

Fields

Modifier and Type	Field and Description
static Extent	ALL_CONTENT A static instance representing an entire object's content.

Constructor Summary

Constructors

Constructor and Description
Extent(long offset, long size) Creates a new extent

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares two extents.
java.lang.String	getHeaderName()
long	getOffset() Returns the starting offset of the extent
long	getSize() Returns the size of the extent.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ALL_CONTENT

public static final Extent ALL_CONTENT

A static instance representing an entire object's content.

Constructor Detail

Extent

public Extent(long offset,
      long size)

Creates a new extent

Parameters:

offset - the starting offset in the object in bytes, starting with 0. Use -1 to represent the entire object.

size - the number of bytes to transfer. Use -1 to represent the entire object.

Method Detail

getSize

public long getSize()

Returns the size of the extent.

Returns:

the extent's size

getOffset

public long getOffset()

Returns the starting offset of the extent

Returns:

the extent's starting offset

equals

public boolean equals(java.lang.Object obj)

Compares two extents. Returns true if they are equal.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHeaderName

public java.lang.String getHeaderName()