StringEncodedValue.java revision 3c3a3c4af82abff185c0699d536dec5002b4406a 
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
32package org.jf.dexlib2.iface.value;
33
34import javax.annotation.Nonnull;
35import javax.annotation.Nullable;
36
37/**
38 * This class represents an encoded string value.
39 */
40public interface StringEncodedValue extends EncodedValue {
41    /**
42     * Gets the string value.
43     *
44     * @return the string value
45     */
46    @Nonnull String getValue();
47
48    /**
49     * Returns a hashcode for this EncodedStringValue.
50     *
51     * This hashCode is defined to be the following:
52     *
53     * <pre>
54     * {@code
55     * int hashCode = getValue().hashCode();
56     * }</pre>
57     *
58     * @return The hash code value for this EncodedStringValue
59     */
60    @Override int hashCode();
61
62    /**
63     * Compares this StringEncodedValue to another StringEncodedValue for equality.
64     *
65     * This StringEncodedValue is equal to another StringEncodedValue if the values returned by getValue() are equal.
66     *
67     * @param o The object to be compared for equality with this StringEncodedValue
68     * @return true if the specified object is equal to this StringEncodedValue
69     */
70    @Override boolean equals(@Nullable Object o);
71
72    /**
73     * Compare this StringEncodedValue to another EncodedValue.
74     *
75     * The comparison is first done on the return values of getValueType(). If the other value is another
76     * StringEncodedValue, the return values of getValue() are compared.
77     *
78     * @param o The EncodedValue to compare with this StringEncodedValue
79     * @return An integer representing the result of the comparison
80     */
81    @Override int compareTo(@Nonnull EncodedValue o);
82}
83