Dexmaker 1.5 · org.droidparts.dexmaker.dx.dex.file.StringIdItem

Modifier and Type	Field and Description
private StringDataItem	data `null-ok;` associated string data object, if known
private final CstString	value `non-null;` the string value

Access	Constructor and Description
public	StringIdItem(CstString `non-null;` the string value value) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
public void	addContents(DexFile `non-null;` the file to populate file) Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.addContents. Populates a `DexFile` with items from within this instance.
public int	compareTo(Object the object to be compared. other) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
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 StringDataItem	Returns: `null-ok;` the associated data object or `null` if not yet known getData() Gets the associated data object for this instance, if known.
public CstString	Returns: `non-null;` the value getValue() Gets the string value.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public ItemType	itemType() Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.itemType. Returns the item type for this instance.
public int	writeSize() Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.writeSize. Gets the size of this instance when written, in bytes.
public void	writeTo(DexFile `non-null;` the file to use for reference file, AnnotatedOutput `non-null;` where to write to out) Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.writeTo. Writes the representation of this instance to the given data section, using the given `DexFile` to look things up as needed.

Inherited from org.droidparts.dexmaker.dx.dex.file.IndexedItem:: getIndex hasIndex indexString setIndex

data	back to summary
private StringDataItem data `null-ok;` associated string data object, if known

value	back to summary
private final CstString value `non-null;` the string value

StringIdItem	back to summary
public StringIdItem(CstString value) Constructs an instance. Parameters value:CstString `non-null;` the string value

Method Detail

addContents back to summary

addContents	back to summary
public void addContents(DexFile file) Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.addContents. Doc from org.droidparts.dexmaker.dx.dex.file.Item.addContents. Populates a `DexFile` with items from within this instance. This will not add an item to the file for this instance itself (which should have been done by whatever refers to this instance). Note Subclasses must override this to do something appropriate. Parameters file:DexFile `non-null;` the file to populate Annotations @Override

public void addContents(DexFile file)

Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.addContents.

Doc from org.droidparts.dexmaker.dx.dex.file.Item.addContents.

Populates a DexFile with items from within this instance. This will not add an item to the file for this instance itself (which should have been done by whatever refers to this instance).

Note

Subclasses must override this to do something appropriate.

Parameters

file:DexFile: non-null; the file to populate

Annotations

@Override

compareTo back to summary

compareTo	back to summary
public int compareTo(Object other) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters other:Object the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

public int compareTo(Object other)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:Object: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

equals back to summary

equals	back 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

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

getData back to summary

getData	back to summary
public StringDataItem getData() Gets the associated data object for this instance, if known. Returns:StringDataItem `null-ok;` the associated data object or `null` if not yet known

public StringDataItem getData()

Gets the associated data object for this instance, if known.

Returns:StringDataItem: null-ok; the associated data object or null if not yet known

getValue back to summary

getValue	back to summary
public CstString getValue() Gets the string value. Returns:CstString `non-null;` the value

public CstString getValue()

Gets the string value.

Returns:CstString: non-null; the value

hashCode back to summary

hashCode	back 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

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

itemType back to summary

itemType	back to summary
public ItemType itemType() Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.itemType. Doc from org.droidparts.dexmaker.dx.dex.file.Item.itemType. Returns the item type for this instance. Returns:ItemType `non-null;` the item type Annotations @Override

public ItemType itemType()

Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.itemType.

Doc from org.droidparts.dexmaker.dx.dex.file.Item.itemType.

Returns the item type for this instance.

Returns:ItemType

non-null; the item type

Annotations

@Override

writeSize back to summary

writeSize	back to summary
public int writeSize() Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.writeSize. Doc from org.droidparts.dexmaker.dx.dex.file.Item.writeSize. Gets the size of this instance when written, in bytes. Returns:int `>= 0;` the write size Annotations @Override

public int writeSize()

Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.writeSize.

Doc from org.droidparts.dexmaker.dx.dex.file.Item.writeSize.

Gets the size of this instance when written, in bytes.

Returns:int

>= 0; the write size

Annotations

@Override

writeTo back to summary

writeTo	back to summary
public void writeTo(DexFile file, AnnotatedOutput out) Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.writeTo. Doc from org.droidparts.dexmaker.dx.dex.file.Item.writeTo. Writes the representation of this instance to the given data section, using the given `DexFile` to look things up as needed. If this instance keeps track of its offset, then this method will note the written offset and will also throw an exception if this instance has already been written. Parameters file:DexFile `non-null;` the file to use for reference out:AnnotatedOutput `non-null;` where to write to Annotations @Override

public void writeTo(DexFile file, AnnotatedOutput out)

Implements abstract org.droidparts.dexmaker.dx.dex.file.Item.writeTo.

Doc from org.droidparts.dexmaker.dx.dex.file.Item.writeTo.

Writes the representation of this instance to the given data section, using the given DexFile to look things up as needed. If this instance keeps track of its offset, then this method will note the written offset and will also throw an exception if this instance has already been written.

Parameters

file:DexFile: non-null; the file to use for reference
out:AnnotatedOutput: non-null; where to write to

Annotations

@Override

public final Class StringIdItem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail