org.apache.tools.zip

Class ZipEightByteInteger

java.lang.Object

org.apache.tools.zip.ZipEightByteInteger

public final class ZipEightByteInteger
extends Object

Utility class that represents an eight byte integer with conversion rules for the big endian byte order of ZIP files.

Field Summary

Fields

Modifier and Type	Field and Description
static ZipEightByteInteger	ZERO

Constructor Summary

Constructors

Constructor and Description
ZipEightByteInteger(BigInteger value) Create instance from a number.
ZipEightByteInteger(byte[] bytes) Create instance from bytes.
ZipEightByteInteger(byte[] bytes, int offset) Create instance from the eight bytes starting at offset.
ZipEightByteInteger(long value) Create instance from a number.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Override to make two instances with same value equal.
byte[]	getBytes() Get value as eight bytes in big endian byte order.
static byte[]	getBytes(BigInteger value) Get value as eight bytes in big endian byte order.
static byte[]	getBytes(long value) Get value as eight bytes in big endian byte order.
long	getLongValue() Get value as Java long.
static long	getLongValue(byte[] bytes) Helper method to get the value as a Java long from an eight-byte array
static long	getLongValue(byte[] bytes, int offset) Helper method to get the value as a Java long from eight bytes starting at given array offset
BigInteger	getValue() Get value as Java long.
static BigInteger	getValue(byte[] bytes) Helper method to get the value as a Java long from an eight-byte array
static BigInteger	getValue(byte[] bytes, int offset) Helper method to get the value as a Java BigInteger from eight bytes starting at given array offset
int	hashCode() Override to make two instances with same value equal.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final ZipEightByteInteger ZERO

Constructor Detail

ZipEightByteInteger

public ZipEightByteInteger(BigInteger value)

Create instance from a number.

Parameters:

value - the BigInteger to store as a ZipEightByteInteger

ZipEightByteInteger

public ZipEightByteInteger(byte[] bytes)

Create instance from bytes.

Parameters:

bytes - the bytes to store as a ZipEightByteInteger

ZipEightByteInteger

public ZipEightByteInteger(byte[] bytes,
                           int offset)

Create instance from the eight bytes starting at offset.

Parameters:

bytes - the bytes to store as a ZipEightByteInteger

offset - the offset to start

ZipEightByteInteger

public ZipEightByteInteger(long value)

Create instance from a number.

Parameters:

value - the long to store as a ZipEightByteInteger

Method Detail

equals

public boolean equals(Object o)

Override to make two instances with same value equal.

Overrides:

equals in class Object

Parameters:

o - an object to compare

Returns:

true if the objects are equal

See Also:

Object.hashCode(), HashMap

getBytes

public byte[] getBytes()

Get value as eight bytes in big endian byte order.

Returns:

value as eight bytes in big endian order

getBytes

public static byte[] getBytes(BigInteger value)

Get value as eight bytes in big endian byte order.

Parameters:

value - the value to convert

Returns:

value as eight bytes in big endian byte order

getBytes

public static byte[] getBytes(long value)

Get value as eight bytes in big endian byte order.

Parameters:

value - the value to convert

Returns:

value as eight bytes in big endian byte order

getLongValue

public long getLongValue()

Get value as Java long.

Returns:

value as a long

getLongValue

public static long getLongValue(byte[] bytes)

Helper method to get the value as a Java long from an eight-byte array

Parameters:

bytes - the array of bytes

Returns:

the corresponding Java long value

getLongValue

public static long getLongValue(byte[] bytes,
                                int offset)

Helper method to get the value as a Java long from eight bytes starting at given array offset

Parameters:

bytes - the array of bytes

offset - the offset to start

Returns:

the corresponding Java long value

getValue

public BigInteger getValue()

Get value as Java long.

Returns:

value as a long

getValue

public static BigInteger getValue(byte[] bytes)

Helper method to get the value as a Java long from an eight-byte array

Parameters:

bytes - the array of bytes

Returns:

the corresponding Java BigInteger value

getValue

public static BigInteger getValue(byte[] bytes,
                                  int offset)

Helper method to get the value as a Java BigInteger from eight bytes starting at given array offset

Parameters:

bytes - the array of bytes

offset - the offset to start

Returns:

the corresponding Java BigInteger value

hashCode

public int hashCode()

Override to make two instances with same value equal.

Overrides:

hashCode in class Object

Returns:

the hashCode of the value stored in the ZipEightByteInteger

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

Description copied from class: Object

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:

toString in class Object

Returns:

a string representation of the object.