src/org/apache/tools/zip/ZipShort.java

   1 /*
   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
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  */
  18
  19 package org.apache.tools.zip;
  20
  21 /**
  22  * Utility class that represents a two byte integer with conversion rules for
  23  * the big endian byte order of ZIP files.
  24  *
  25  */
  26 public final class ZipShort implements Cloneable {
  27
  28   private int value;
  29
  30   /**
  31    * Create instance from a number.
  32    *
  33    * @param value
  34    *          the int to store as a ZipShort
  35    * @since 1.1
  36    */
  37   public ZipShort(int value) {
  38     this.value = value;
  39   }
  40
  41   /**
  42    * Create instance from bytes.
  43    *
  44    * @param bytes
  45    *          the bytes to store as a ZipShort
  46    * @since 1.1
  47    */
  48   public ZipShort(byte[] bytes) {
  49     this(bytes, 0);
  50   }
  51
  52   /**
  53    * Create instance from the two bytes starting at offset.
  54    *
  55    * @param bytes
  56    *          the bytes to store as a ZipShort
  57    * @param offset
  58    *          the offset to start
  59    * @since 1.1
  60    */
  61   public ZipShort(byte[] bytes, int offset) {
  62     value = ZipShort.getValue(bytes, offset);
  63   }
  64
  65   /**
  66    * Get value as two bytes in big endian byte order.
  67    *
  68    * @return the value as a a two byte array in big endian byte order
  69    * @since 1.1
  70    */
  71   public byte[] getBytes() {
  72     byte[] result = new byte[2];
  73     result[0] = (byte) (value & 0xFF);
  74     result[1] = (byte) ((value & 0xFF00) >> 8);
  75     return result;
  76   }
  77
  78   /**
  79    * Get value as Java int.
  80    *
  81    * @return value as a Java int
  82    * @since 1.1
  83    */
  84   public int getValue() {
  85     return value;
  86   }
  87
  88   /**
  89    * Get value as two bytes in big endian byte order.
  90    *
  91    * @param value
  92    *          the Java int to convert to bytes
  93    * @return the converted int as a byte array in big endian byte order
  94    */
  95   public static byte[] getBytes(int value) {
  96     byte[] result = new byte[2];
  97     result[0] = (byte) (value & 0xFF);
  98     result[1] = (byte) ((value & 0xFF00) >> 8);
  99     return result;
 100   }
 101
 102   /**
 103    * Helper method to get the value as a java int from two bytes starting at
 104    * given array offset
 105    *
 106    * @param bytes
 107    *          the array of bytes
 108    * @param offset
 109    *          the offset to start
 110    * @return the correspondanding java int value
 111    */
 112   public static int getValue(byte[] bytes, int offset) {
 113     int value = (bytes[offset + 1] << 8) & 0xFF00;
 114     value += (bytes[offset] & 0xFF);
 115     return value;
 116   }
 117
 118   /**
 119    * Helper method to get the value as a java int from a two-byte array
 120    *
 121    * @param bytes
 122    *          the array of bytes
 123    * @return the correspondanding java int value
 124    */
 125   public static int getValue(byte[] bytes) {
 126     return getValue(bytes, 0);
 127   }
 128
 129   /**
 130    * Override to make two instances with same value equal.
 131    *
 132    * @param o
 133    *          an object to compare
 134    * @return true if the objects are equal
 135    * @since 1.1
 136    */
 137   public boolean equals(Object o) {
 138     if (o == null || !(o instanceof ZipShort)) {
 139       return false;
 140     }
 141     return value == ((ZipShort) o).getValue();
 142   }
 143
 144   /**
 145    * Override to make two instances with same value equal.
 146    *
 147    * @return the value stored in the ZipShort
 148    * @since 1.1
 149    */
 150   public int hashCode() {
 151     return value;
 152   }
 153 }