Home | History | Annotate | Download | only in value 
      1 /*
      2  * Copyright 2012, Google Inc.
      3  * All rights reserved.
      4  *
      5  * Redistribution and use in source and binary forms, with or without
      6  * modification, are permitted provided that the following conditions are
      7  * met:
      8  *
      9  *     * Redistributions of source code must retain the above copyright
     10  * notice, this list of conditions and the following disclaimer.
     11  *     * Redistributions in binary form must reproduce the above
     12  * copyright notice, this list of conditions and the following disclaimer
     13  * in the documentation and/or other materials provided with the
     14  * distribution.
     15  *     * Neither the name of Google Inc. nor the names of its
     16  * contributors may be used to endorse or promote products derived from
     17  * this software without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 package org.jf.dexlib2.iface.value;
     33 
     34 import javax.annotation.Nonnull;
     35 import javax.annotation.Nullable;
     36 
     37 /**
     38  * This class represents an encoded null value.
     39  */
     40 public interface NullEncodedValue extends EncodedValue {
     41     /**
     42      * Returns a hashcode for this EncodedNullValue.
     43      *
     44      * This hashCode is defined to be the following:
     45      *
     46      * <pre>
     47      * {@code
     48      * int hashCode = 0;
     49      * }</pre>
     50      *
     51      * @return The hash code value for this EncodedNullValue
     52      */
     53     @Override int hashCode();
     54 
     55     /**
     56      * Compares this NullEncodedValue to another NullEncodedValue for equality.
     57      *
     58      * This NullEncodedValue is always equal to another other NullEncodedValue
     59      *
     60      * @param o The object to be compared for equality with this NullEncodedValue
     61      * @return true if the specified object is equal to this NullEncodedValue
     62      */
     63     @Override boolean equals(@Nullable Object o);
     64 
     65     /**
     66      * Compare this NullEncodedValue to another EncodedValue.
     67      *
     68      * The comparison is first done on the return values of getValueType(). If the other value is another
     69      * NullEncodedValue, then 0 is returned.
     70      *
     71      * @param o The EncodedValue to compare with this NullEncodedValue
     72      * @return An integer representing the result of the comparison
     73      */
     74     @Override int compareTo(@Nonnull EncodedValue o);
     75 }
     76