org.jivesoftware.smackx.jingle_filetransfer.element

Class Range

java.lang.Object

org.jivesoftware.smackx.jingle_filetransfer.element.Range

All Implemented Interfaces:

Element, NamedElement

public class Range
extends Object
implements NamedElement

RangeElement which specifies, which range of a file shall be transferred.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_LENGTH
static String	ATTR_OFFSET
static String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
Range() Create a Range element with default values.
Range(int length) Create a Range element with specified length.
Range(int offset, int length) Create a Range element with specified offset and length.
Range(int offset, int length, HashElement hash) Create a Range element with specified offset, length and hash.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getElementName() Returns the root element name.
HashElement	getHash() Return the hash element that contains a checksum of the bytes specified in the range.
int	getLength() Return the length of the range.
int	getOffset() Return the index of the offset.
int	hashCode()
CharSequence	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

ATTR_OFFSET

public static final String ATTR_OFFSET

See Also:

Constant Field Values

ATTR_LENGTH

public static final String ATTR_LENGTH

See Also:

Constant Field Values

Constructor Detail

Range

public Range()

Create a Range element with default values.

Range

public Range(int length)

Create a Range element with specified length.

Parameters:

length - length of the transmitted data in bytes.

Range

public Range(int offset,
             int length)

Create a Range element with specified offset and length.

Parameters:

offset - offset in bytes from the beginning of the transmitted data.

length - number of bytes that shall be transferred.

Range

public Range(int offset,
             int length,
             HashElement hash)

Create a Range element with specified offset, length and hash.

Parameters:

offset - offset in bytes from the beginning of the transmitted data.

length - number of bytes that shall be transferred.

hash - hash of the bytes in the specified range.

Method Detail

getOffset

public int getOffset()

Return the index of the offset. This marks the begin of the specified range.

Returns:

offset

getLength

public int getLength()

Return the length of the range.

Returns:

length

getHash

public HashElement getHash()

Return the hash element that contains a checksum of the bytes specified in the range.

Returns:

hash element

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

toXML

public CharSequence toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object