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 boolean value.
     39  */
     40 public interface BooleanEncodedValue extends EncodedValue {
     41     /**
     42      * Gets the boolean value.
     43      *
     44      * @return the boolean value
     45      */
     46     boolean getValue();
     47 
     48     /**
     49      * Returns a hashcode for this EncodedBooleanValue.
     50      *
     51      * This hashCode is defined to be the following:
     52      *
     53      * <pre>
     54      * {@code
     55      * int hashCode = getValue()?1:0;
     56      * }</pre>
     57      *
     58      * @return The hash code value for this EncodedBooleanValue
     59      */
     60     @Override int hashCode();
     61 
     62     /**
     63      * Compares this BooleanEncodedValue to another BooleanEncodedValue for equality.
     64      *
     65      * This BooleanEncodedValue is equal to another BooleanEncodedValue if the values returned by getValue() are equal.
     66      *
     67      * @param o The object to be compared for equality with this BooleanEncodedValue
     68      * @return true if the specified object is equal to this BooleanEncodedValue
     69      */
     70     @Override boolean equals(@Nullable Object o);
     71 
     72     /**
     73      * Compare this BooleanEncodedValue to another EncodedValue.
     74      *
     75      * The comparison is first done on the return values of getValueType(). If the other value is another
     76      * BooleanEncodedValue, the return values of getValue() are compared, based on the semantics of
     77      * Boolean.compareTo().
     78      *
     79      * @param o The EncodedValue to compare with this BooleanEncodedValue
     80      * @return An integer representing the result of the comparison
     81      */
     82     @Override int compareTo(@Nonnull EncodedValue o);
     83 }
     84