Top Description Fields Constructors Methods
org.droidparts.dexmaker.dx.rop.cst

public final Class CstString

extends TypedConstant
Class Inheritance
Imports
org.droidparts.dexmaker.dx.rop.type.Type, org.droidparts.dexmaker.dx.util.ByteArray, .Hex
Constants of type CONSTANT_Utf8_info or CONSTANT_String_info.

Field Summary

Modifier and TypeField and Description
private final ByteArray
bytes

non-null; the UTF-8 value as bytes

public static final CstString
EMPTY_STRING

non-null; instance representing "", that is, the empty string

private final String
string

non-null; the UTF-8 value as a string

Constructor Summary

AccessConstructor and Description
public
CstString(String
non-null; the UTF-8 value as a string
string)

Constructs an instance from a String.

public
CstString(ByteArray
non-null; array of the UTF-8 bytes
bytes)

Constructs an instance from some UTF-8 bytes.

Method Summary

Modifier and TypeMethod and Description
protected int
compareTo0(Constant
non-null; the instance to compare to
other)

Implements abstract org.droidparts.dexmaker.dx.rop.cst.Constant.compareTo0.

Compare the values of this and another instance, which are guaranteed to be of the same class.
public boolean
equals(Object
the reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public ByteArray

Returns:

non-null; an array of the UTF-8 bytes
getBytes()

Gets the UTF-8 value as UTF-8 encoded bytes.

public String

Returns:

non-null; the UTF-8 value as a string
getString()

Gets the UTF-8 value as a string.

public Type
getType()

Implements org.droidparts.dexmaker.dx.rop.type.TypeBearer.getType.

Gets the type associated with this instance.
public int

Returns:

>= 0; the UTF-16 size
getUtf16Size()

Gets the size of this instance as UTF-16 code points.

public int

Returns:

>= 0; the UTF-8 size
getUtf8Size()

Gets the size of this instance as UTF-8 code points.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public boolean
isCategory2()

Implements abstract org.droidparts.dexmaker.dx.rop.cst.Constant.isCategory2.

Returns true if this instance is a category-2 constant, meaning it takes up two slots in the constant pool, or false if this instance is category-1.
public static byte[]

Returns:

non-null; the UTF-8 bytes for it
stringToUtf8Bytes(String
non-null; the string to convert
string)

Converts a string into its MUTF-8 form.

private static String

Returns:

never
throwBadUtf8(int
the byte value
value, int
the file offset
offset)

Helper for utf8BytesToString, which throws the right exception for a bogus utf-8 byte.

public String
toHuman()

Implements org.droidparts.dexmaker.dx.util.ToHuman.toHuman.

Return the "human" string form of this instance.
public String

Returns:

non-null; the quoted string
toQuoted()

Gets the value as a human-oriented string, surrounded by double quotes.

public String

Returns:

non-null; the quoted string
toQuoted(int
>= 5; the maximum length of the string to return
maxLength)

Gets the value as a human-oriented string, surrounded by double quotes, but ellipsizes the result if it is longer than the given maximum length

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public String
typeName()

Implements abstract org.droidparts.dexmaker.dx.rop.cst.Constant.typeName.

Returns the human name for the particular type of constant this instance is.
public static String

Returns:

non-null; the converted string
utf8BytesToString(ByteArray
non-null; the bytes to convert
bytes)

Converts an array of UTF-8 bytes into a string.

Inherited from org.droidparts.dexmaker.dx.rop.cst.TypedConstant:
getBasicFrameTypegetBasicTypegetFrameTypeisConstant

Field Detail

bytesback to summary
private final ByteArray bytes

non-null; the UTF-8 value as bytes

EMPTY_STRINGback to summary
public static final CstString EMPTY_STRING

non-null; instance representing "", that is, the empty string

stringback to summary
private final String string

non-null; the UTF-8 value as a string

Constructor Detail

CstStringback to summary
public CstString(String string)

Constructs an instance from a String.

Parameters
string:String

non-null; the UTF-8 value as a string

CstStringback to summary
public CstString(ByteArray bytes)

Constructs an instance from some UTF-8 bytes.

Parameters
bytes:ByteArray

non-null; array of the UTF-8 bytes

Method Detail

compareTo0back to summary
protected int compareTo0(Constant other)

Implements abstract org.droidparts.dexmaker.dx.rop.cst.Constant.compareTo0.

Doc from org.droidparts.dexmaker.dx.rop.cst.Constant.compareTo0.

Compare the values of this and another instance, which are guaranteed to be of the same class. Subclasses must implement this.

Parameters
other:Constant

non-null; the instance to compare to

Returns:int

-1, 0, or 1, as usual for a comparison

Annotations
@Override
equalsback to summary
public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
other:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getBytesback to summary
public ByteArray getBytes()

Gets the UTF-8 value as UTF-8 encoded bytes.

Returns:ByteArray

non-null; an array of the UTF-8 bytes

getStringback to summary
public String getString()

Gets the UTF-8 value as a string. The returned string is always already interned.

Returns:String

non-null; the UTF-8 value as a string

getTypeback to summary
public Type getType()

Implements org.droidparts.dexmaker.dx.rop.type.TypeBearer.getType.

Doc from org.droidparts.dexmaker.dx.rop.type.TypeBearer.getType.

Gets the type associated with this instance.

Returns:Type

non-null; the type

getUtf16Sizeback to summary
public int getUtf16Size()

Gets the size of this instance as UTF-16 code points. That is, get the number of 16-bit chars in the UTF-16 encoding of this instance. This is the same as the length of the Java String representation of this instance.

Returns:int

>= 0; the UTF-16 size

getUtf8Sizeback to summary
public int getUtf8Size()

Gets the size of this instance as UTF-8 code points. That is, get the number of bytes in the UTF-8 encoding of this instance.

Returns:int

>= 0; the UTF-8 size

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isCategory2back to summary
public boolean isCategory2()

Implements abstract org.droidparts.dexmaker.dx.rop.cst.Constant.isCategory2.

Doc from org.droidparts.dexmaker.dx.rop.cst.Constant.isCategory2.

Returns true if this instance is a category-2 constant, meaning it takes up two slots in the constant pool, or false if this instance is category-1.

Returns:boolean

true iff this instance is category-2

Annotations
@Override
stringToUtf8Bytesback to summary
public static byte[] stringToUtf8Bytes(String string)

Converts a string into its MUTF-8 form. MUTF-8 differs from normal UTF-8 in the handling of character '\0' and surrogate pairs.

Parameters
string:String

non-null; the string to convert

Returns:byte[]

non-null; the UTF-8 bytes for it

throwBadUtf8back to summary
private static String throwBadUtf8(int value, int offset)

Helper for utf8BytesToString, which throws the right exception for a bogus utf-8 byte.

Parameters
value:int

the byte value

offset:int

the file offset

Returns:String

never

Exceptions
IllegalArgumentException:
always thrown
toHumanback to summary
public String toHuman()

Implements org.droidparts.dexmaker.dx.util.ToHuman.toHuman.

Doc from org.droidparts.dexmaker.dx.util.ToHuman.toHuman.

Return the "human" string form of this instance. This is generally less "debuggy" than toString().

Returns:String

non-null; the human string form

toQuotedback to summary
public String toQuoted()

Gets the value as a human-oriented string, surrounded by double quotes.

Returns:String

non-null; the quoted string

toQuotedback to summary
public String toQuoted(int maxLength)

Gets the value as a human-oriented string, surrounded by double quotes, but ellipsizes the result if it is longer than the given maximum length

Parameters
maxLength:int

>= 5; the maximum length of the string to return

Returns:String

non-null; the quoted string

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override
typeNameback to summary
public String typeName()

Implements abstract org.droidparts.dexmaker.dx.rop.cst.Constant.typeName.

Doc from org.droidparts.dexmaker.dx.rop.cst.Constant.typeName.

Returns the human name for the particular type of constant this instance is.

Returns:String

non-null; the name

Annotations
@Override
utf8BytesToStringback to summary
public static String utf8BytesToString(ByteArray bytes)

Converts an array of UTF-8 bytes into a string.

Parameters
bytes:ByteArray

non-null; the bytes to convert

Returns:String

non-null; the converted string