1a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver/* 2a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * Copyright 2012, Google Inc. 3a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * All rights reserved. 4a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * 5a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * Redistribution and use in source and binary forms, with or without 6a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * modification, are permitted provided that the following conditions are 7a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * met: 8a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * 9a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * * Redistributions of source code must retain the above copyright 10a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * notice, this list of conditions and the following disclaimer. 11a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * * Redistributions in binary form must reproduce the above 12a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * copyright notice, this list of conditions and the following disclaimer 13a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * in the documentation and/or other materials provided with the 14a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * distribution. 15a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * * Neither the name of Google Inc. nor the names of its 16a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * contributors may be used to endorse or promote products derived from 17a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * this software without specific prior written permission. 18a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * 19a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver */ 31a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver 32a8e05220c14778d93c97911044ff5124aadbd77cBen Gruverpackage org.jf.dexlib2.iface.reference; 33a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver 34a8e05220c14778d93c97911044ff5124aadbd77cBen Gruverimport javax.annotation.Nonnull; 3522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruverimport javax.annotation.Nullable; 36a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver 3722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver/** 3822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * This class represents a reference to an arbitrary string. 3922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 4022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * When possible, elsewhere in the interface, a string is represented directly by its value. A StringReference is only 4122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * used in those cases where a generic Reference is needed 4222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 4322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * This type also acts as a CharSequence wrapper around the referenced string value. As per the CharSequence contract, 4422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * calling toString() on a StringReference yields the referenced string value. This is the same value returned by 4522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * getString(). 4622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 4722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruverpublic interface StringReference extends Reference, CharSequence, Comparable<CharSequence> { 4822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 4922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Gets the referenced string. 5022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 5122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return the referenced string 5222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 53a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver @Nonnull String getString(); 5422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 5522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 5622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Returns a hashcode for this StringReference. 5722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 5822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * This is defined to be getString().hashCode(). 5922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 6022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return The hash code value for this StringReference 6122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 6222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Override int hashCode(); 6322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 6422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 6522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Compares this StringReference to another CharSequence for equality. 6622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 6722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * String StringReference is equal to a CharSequence iff this.getString().equals(other.toString()). 6822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 6922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Equivalently, This StringReference is equal to another StringReference iff 7022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * this.getString().equals(other.getString()). 7122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 7222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @param o The object to be compared for equality with this TypeReference 7322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return true if the specified object is equal to this TypeReference 7422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 7522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Override boolean equals(@Nullable Object o); 7622c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver 7722c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver /** 7822c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * Compare this StringReference to another StringReference, or more generally to another CharSequence. 7922c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 8022c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * The comparison is defined to be this.getString().compareTo(other.toString()). 8122c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * 8222c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @param o The CharSequence to compare with this StringReference 8322c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver * @return An integer representing the result of the comparison 8422c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver */ 8522c3185bb7c8618437eabe6c597549e0989ec4e6Ben Gruver @Override int compareTo(@Nonnull CharSequence o); 86a8e05220c14778d93c97911044ff5124aadbd77cBen Gruver} 87