org.apache.tools.zip

Class ZipShort

java.lang.Object

org.apache.tools.zip.ZipShort

All Implemented Interfaces:

Cloneable

public final class ZipShort
extends Object
implements Cloneable

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

Constructor Summary

Constructors

Constructor and Description
ZipShort(byte[] bytes) Create instance from bytes.
ZipShort(byte[] bytes, int offset) Create instance from the two bytes starting at offset.
ZipShort(int value) Create instance from a number.

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates and returns a copy of this object.
boolean	equals(Object o) Override to make two instances with same value equal.
byte[]	getBytes() Get value as two bytes in big endian byte order.
static byte[]	getBytes(int value) Get value as two bytes in big endian byte order.
int	getValue() Get value as Java int.
static int	getValue(byte[] bytes) Helper method to get the value as a java int from a two-byte array
static int	getValue(byte[] bytes, int offset) Helper method to get the value as a java int from two bytes starting at given array offset
int	hashCode() Override to make two instances with same value equal.
static void	putShort(int value, byte[] buf, int offset) put the value as two bytes in big endian byte order.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ZipShort

public ZipShort(byte[] bytes)

Create instance from bytes.

Parameters:

bytes - the bytes to store as a ZipShort

Since:

1.1

ZipShort

public ZipShort(byte[] bytes,
                int offset)

Create instance from the two bytes starting at offset.

Parameters:

bytes - the bytes to store as a ZipShort

offset - the offset to start

Since:

1.1

ZipShort

public ZipShort(int value)

Create instance from a number.

Parameters:

value - the int to store as a ZipShort

Since:

1.1

Method Detail

clone

public Object clone()

Description copied from class: Object

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

 x.clone() != x
 

will be true, and that the expression:

 x.clone().getClass() == x.getClass()
 

will be true, but these are not absolute requirements. While it is typically the case that:

 x.clone().equals(x)
 

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

The method clone for class Object performs a specific cloning operation. First, if the class of this object does not implement the interface Cloneable, then a CloneNotSupportedException is thrown. Note that all arrays are considered to implement the interface Cloneable and that the return type of the clone method of an array type T[] is T[] where T is any reference or primitive type. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

The class Object does not itself implement the interface Cloneable, so calling the clone method on an object whose class is Object will result in throwing an exception at run time.

Overrides:

clone in class Object

Returns:

a clone of this instance.

See Also:

Cloneable

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

Since:

1.1

See Also:

Object.hashCode(), HashMap

getBytes

public byte[] getBytes()

Get value as two bytes in big endian byte order.

Returns:

the value as a a two byte array in big endian byte order

Since:

1.1

getBytes

public static byte[] getBytes(int value)

Get value as two bytes in big endian byte order.

Parameters:

value - the Java int to convert to bytes

Returns:

the converted int as a byte array in big endian byte order

getValue

public int getValue()

Get value as Java int.

Returns:

value as a Java int

Since:

1.1

getValue

public static int getValue(byte[] bytes)

Helper method to get the value as a java int from a two-byte array

Parameters:

bytes - the array of bytes

Returns:

the corresponding java int value

getValue

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

Helper method to get the value as a java int from two bytes starting at given array offset

Parameters:

bytes - the array of bytes

offset - the offset to start

Returns:

the corresponding java int value

hashCode

public int hashCode()

Override to make two instances with same value equal.

Overrides:

hashCode in class Object

Returns:

the value stored in the ZipShort

Since:

1.1

See Also:

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

putShort

public static void putShort(int value,
                            byte[] buf,
                            int offset)

put the value as two bytes in big endian byte order.

Parameters:

value - the Java int to convert to bytes

buf - the output buffer

offset - The offset within the output buffer of the first byte to be written. must be non-negative and no larger than buf.length-2

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.