Home | History | Annotate | Download | only in reference 
      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.reference;
     33 
     34 import javax.annotation.Nonnull;
     35 import javax.annotation.Nullable;
     36 
     37 /**
     38  * This class represents a reference to an arbitrary string.
     39  *
     40  * When possible, elsewhere in the interface, a string is represented directly by its value. A StringReference is only
     41  * used  in those cases where a generic Reference is needed
     42  *
     43  * This type also acts as a CharSequence wrapper around the referenced string value. As per the CharSequence contract,
     44  * calling toString() on a StringReference yields the referenced string value. This is the same value returned by
     45  * getString().
     46  */
     47 public interface StringReference extends Reference, CharSequence, Comparable<CharSequence> {
     48     /**
     49      * Gets the referenced string.
     50      *
     51      * @return the referenced string
     52      */
     53     @Nonnull String getString();
     54 
     55     /**
     56      * Returns a hashcode for this StringReference.
     57      *
     58      * This is defined to be getString().hashCode().
     59      *
     60      * @return The hash code value for this StringReference
     61      */
     62     @Override int hashCode();
     63 
     64     /**
     65      * Compares this StringReference to another CharSequence for equality.
     66      *
     67      * String StringReference is equal to a CharSequence iff this.getString().equals(other.toString()).
     68      *
     69      * Equivalently, This StringReference is equal to another StringReference iff
     70      * this.getString().equals(other.getString()).
     71      *
     72      * @param o The object to be compared for equality with this TypeReference
     73      * @return true if the specified object is equal to this TypeReference
     74      */
     75     @Override boolean equals(@Nullable Object o);
     76 
     77     /**
     78      * Compare this StringReference to another StringReference, or more generally to another CharSequence.
     79      *
     80      * The comparison is defined to be this.getString().compareTo(other.toString()).
     81      *
     82      * @param o The CharSequence to compare with this StringReference
     83      * @return An integer representing the result of the comparison
     84      */
     85     @Override int compareTo(@Nonnull CharSequence o);
     86 }
     87