2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
19 package org.apache.tools.zip;
22 * Utility class that represents a two byte integer with conversion
23 * rules for the big endian byte order of ZIP files.
26 public final class ZipShort implements Cloneable {
31 * Create instance from a number.
32 * @param value the int to store as a ZipShort
35 public ZipShort (int value) {
40 * Create instance from bytes.
41 * @param bytes the bytes to store as a ZipShort
44 public ZipShort (byte[] bytes) {
49 * Create instance from the two bytes starting at offset.
50 * @param bytes the bytes to store as a ZipShort
51 * @param offset the offset to start
54 public ZipShort (byte[] bytes, int offset) {
55 value = ZipShort.getValue(bytes, offset);
59 * Get value as two bytes in big endian byte order.
60 * @return the value as a a two byte array in big endian byte order
63 public byte[] getBytes() {
64 byte[] result = new byte[2];
65 result[0] = (byte) (value & 0xFF);
66 result[1] = (byte) ((value & 0xFF00) >> 8);
71 * Get value as Java int.
72 * @return value as a Java int
75 public int getValue() {
80 * Get value as two bytes in big endian byte order.
81 * @param value the Java int to convert to bytes
82 * @return the converted int as a byte array in big endian byte order
84 public static byte[] getBytes(int value) {
85 byte[] result = new byte[2];
86 result[0] = (byte) (value & 0xFF);
87 result[1] = (byte) ((value & 0xFF00) >> 8);
92 * Helper method to get the value as a java int from two bytes starting at given array offset
93 * @param bytes the array of bytes
94 * @param offset the offset to start
95 * @return the correspondanding java int value
97 public static int getValue(byte[] bytes, int offset) {
98 int value = (bytes[offset + 1] << 8) & 0xFF00;
99 value += (bytes[offset] & 0xFF);
104 * Helper method to get the value as a java int from a two-byte array
105 * @param bytes the array of bytes
106 * @return the correspondanding java int value
108 public static int getValue(byte[] bytes) {
109 return getValue(bytes, 0);
113 * Override to make two instances with same value equal.
114 * @param o an object to compare
115 * @return true if the objects are equal
118 public boolean equals(Object o) {
119 if (o == null || !(o instanceof ZipShort)) {
122 return value == ((ZipShort) o).getValue();
126 * Override to make two instances with same value equal.
127 * @return the value stored in the ZipShort
130 public int hashCode() {