Modifier and Type	Class and Description
private static class	ByteArrayAnnotatedOutput.Annotation Annotation on output.

Modifier and Type	Field and Description
private ArrayList<ByteArrayAnnotatedOutput.Annotation>	annotations `null-ok;` list of annotations, or `null` if this instance isn't keeping them
private int	annotationWidth `>= 40 (if used);` the desired maximum annotation width
private int	cursor `>= 0;` current output cursor
private byte[]	data `non-null;` the data itself
private static final int	DEFAULT_SIZE default size for stretchy instances
private int	hexCols `>= 8 (if used);` the number of bytes of hex output to use in annotations
private final boolean	stretchy whether the instance is stretchy, that is, whether its array may be resized to increase capacity
private boolean	verbose whether annotations are to be verbose

Access	Constructor and Description
public	ByteArrayAnnotatedOutput(byte[] `non-null;` data array to use for output data) Constructs an instance with a fixed maximum size.
public	ByteArrayAnnotatedOutput() Constructs a "stretchy" instance.
public	ByteArrayAnnotatedOutput(int size) Constructs a "stretchy" instance with initial size `size`.
private	ByteArrayAnnotatedOutput(byte[] `non-null;` data array to use for output data, boolean whether the instance is to be stretchy stretchy) Internal constructor.

Method Summary

Modifier and Type	Method and Description
public void	alignTo(int `> 0;` the alignment; must be a power of two alignment) Implements org.droidparts.dexmaker.dx.util.Output.alignTo. Adds extra bytes if necessary (with value `0`) to force alignment of the output cursor as given.
public void	annotate(String `non-null;` the annotation message msg) Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate. Add an annotation for the subsequent output.
public void	annotate(int `>= 0;` the amount of output for this annotation to cover amt, String `non-null;` the annotation message msg) Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate. Add an annotation for a specified amount of subsequent output.
public boolean	annotates() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotates. Get whether this instance will actually keep annotations.
public void	assertCursor(int the expected cursor value expectedCursor) Implements org.droidparts.dexmaker.dx.util.Output.assertCursor. Asserts that the cursor is the given value.
public void	enableAnnotations(int `>= 40;` the desired maximum annotation width annotationWidth, boolean whether or not to indicate verbose annotations verbose) Indicates that this instance should keep annotations.
public void	endAnnotation() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.endAnnotation. End the most recent annotation.
private void	ensureCapacity(int `>= 0;` the desired minimum total size of the array desiredSize) Reallocates the underlying array if necessary.
public void	finishAnnotating() Finishes up annotation processing.
public int	getAnnotationWidth() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.getAnnotationWidth. Get the maximum width of the annotated output.
public byte[]	Returns: `non-null;` the `byte[]` getArray() Gets the underlying `byte[]` of this instance, which may be larger than the number of bytes written
public int	getCursor() Implements org.droidparts.dexmaker.dx.util.Output.getCursor. Gets the current cursor position.
public boolean	isVerbose() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.isVerbose. Get whether this instance is intended to keep verbose annotations.
private static void	throwBounds() Throws the excpetion for when an attempt is made to write past the end of the instance.
public byte[]	Returns: `non-null;` an appropriately-constructed array toByteArray() Constructs and returns a new `byte[]` that contains the written contents exactly (that is, with no extra unwritten bytes at the end).
public void	write(ByteArray `non-null;` the array to write bytes) Implements org.droidparts.dexmaker.dx.util.Output.write. Writes a `ByteArray` to this instance.
public void	write(byte[] `non-null;` the array to write bytes, int `>= 0;` offset into `bytes` for the first byte to write offset, int `>= 0;` number of bytes to write length) Implements org.droidparts.dexmaker.dx.util.Output.write. Writes a portion of a `byte[]` to this instance.
public void	write(byte[] `non-null;` the array to write bytes) Implements org.droidparts.dexmaker.dx.util.Output.write. Writes a `byte[]` to this instance.
public void	writeAnnotationsTo(Writer `non-null;` where to write to out) Writes the annotated content of this instance to the given writer.
public void	writeByte(int the value to write; all but the low 8 bits are ignored value) Implements org.droidparts.dexmaker.dx.util.Output.writeByte, org.droidparts.dexmaker.dx.util.ByteOutput.writeByte. Writes a byte.
public void	writeInt(int the value to write value) Implements org.droidparts.dexmaker.dx.util.Output.writeInt. Writes an `int` to this instance.
public void	writeLong(long the value to write value) Implements org.droidparts.dexmaker.dx.util.Output.writeLong. Writes a `long` to this instance.
public void	writeShort(int the value to write; all but the low 16 bits are ignored value) Implements org.droidparts.dexmaker.dx.util.Output.writeShort. Writes a `short` to this instance.
public int	writeSleb128(int value to write value) Implements org.droidparts.dexmaker.dx.util.Output.writeSleb128. Writes a DWARFv3-style unsigned LEB128 integer.
public int	writeUleb128(int value to write, treated as an unsigned value value) Implements org.droidparts.dexmaker.dx.util.Output.writeUleb128. Writes a DWARFv3-style unsigned LEB128 integer.
public void	writeZeroes(int `>= 0;` the number of zeroes to write count) Implements org.droidparts.dexmaker.dx.util.Output.writeZeroes. Writes the given number of `0` bytes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

annotations	back to summary
private ArrayList<ByteArrayAnnotatedOutput.Annotation> annotations `null-ok;` list of annotations, or `null` if this instance isn't keeping them

annotationWidth	back to summary
private int annotationWidth `>= 40 (if used);` the desired maximum annotation width

cursor	back to summary
private int cursor `>= 0;` current output cursor

data	back to summary
private byte[] data `non-null;` the data itself

DEFAULT_SIZE	back to summary
private static final int DEFAULT_SIZE default size for stretchy instances

hexCols	back to summary
private int hexCols `>= 8 (if used);` the number of bytes of hex output to use in annotations

stretchy	back to summary
private final boolean stretchy whether the instance is stretchy, that is, whether its array may be resized to increase capacity

verbose	back to summary
private boolean verbose whether annotations are to be verbose

Constructor Detail

ByteArrayAnnotatedOutput back to summary

ByteArrayAnnotatedOutput	back to summary
public ByteArrayAnnotatedOutput(byte[] data) Constructs an instance with a fixed maximum size. Note that the given array is the only one that will be used to store data. In particular, no reallocation will occur in order to expand the capacity of the resulting instance. Also, the constructed instance does not keep annotations by default. Parameters data:byte[] `non-null;` data array to use for output

public ByteArrayAnnotatedOutput(byte[] data)

Constructs an instance with a fixed maximum size. Note that the given array is the only one that will be used to store data. In particular, no reallocation will occur in order to expand the capacity of the resulting instance. Also, the constructed instance does not keep annotations by default.

Parameters

data:byte[]: non-null; data array to use for output

ByteArrayAnnotatedOutput	back to summary
public ByteArrayAnnotatedOutput() Constructs a "stretchy" instance. The underlying array may be reallocated. The constructed instance does not keep annotations by default.

ByteArrayAnnotatedOutput	back to summary
public ByteArrayAnnotatedOutput(int size) Constructs a "stretchy" instance with initial size `size`. The underlying array may be reallocated. The constructed instance does not keep annotations by default.

ByteArrayAnnotatedOutput back to summary

ByteArrayAnnotatedOutput	back to summary
private ByteArrayAnnotatedOutput(byte[] data, boolean stretchy) Internal constructor. Parameters data:byte[] `non-null;` data array to use for output stretchy:boolean whether the instance is to be stretchy

private ByteArrayAnnotatedOutput(byte[] data, boolean stretchy)

Internal constructor.

Parameters

data:byte[]: non-null; data array to use for output
stretchy:boolean: whether the instance is to be stretchy

Method Detail

alignTo back to summary

alignTo	back to summary
public void alignTo(int alignment) Implements org.droidparts.dexmaker.dx.util.Output.alignTo. Doc from org.droidparts.dexmaker.dx.util.Output.alignTo. Adds extra bytes if necessary (with value `0`) to force alignment of the output cursor as given. Parameters alignment:int `> 0;` the alignment; must be a power of two

public void alignTo(int alignment)

Implements org.droidparts.dexmaker.dx.util.Output.alignTo.

Doc from org.droidparts.dexmaker.dx.util.Output.alignTo.

Adds extra bytes if necessary (with value 0) to force alignment of the output cursor as given.

Parameters

alignment:int: > 0; the alignment; must be a power of two

annotate back to summary

annotate	back to summary
public void annotate(String msg) Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate. Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate. Add an annotation for the subsequent output. Any previously open annotation will be closed by this call, and the new annotation marks all subsequent output until another annotation call. Parameters msg:String `non-null;` the annotation message

public void annotate(String msg)

Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate.

Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate.

Add an annotation for the subsequent output. Any previously open annotation will be closed by this call, and the new annotation marks all subsequent output until another annotation call.

Parameters

msg:String: non-null; the annotation message

annotate back to summary

annotate	back to summary
public void annotate(int amt, String msg) Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate. Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate. Add an annotation for a specified amount of subsequent output. Any previously open annotation will be closed by this call. If there is already pending annotation from one or more previous calls to this method, the new call "consumes" output after all the output covered by the previous calls. Parameters amt:int `>= 0;` the amount of output for this annotation to cover msg:String `non-null;` the annotation message

public void annotate(int amt, String msg)

Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate.

Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotate.

Add an annotation for a specified amount of subsequent output. Any previously open annotation will be closed by this call. If there is already pending annotation from one or more previous calls to this method, the new call "consumes" output after all the output covered by the previous calls.

Parameters

amt:int: >= 0; the amount of output for this annotation to cover
msg:String: non-null; the annotation message

annotates back to summary

annotates	back to summary
public boolean annotates() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotates. Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotates. Get whether this instance will actually keep annotations. Returns:boolean `true` iff annotations are being kept

public boolean annotates()

Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotates.

Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.annotates.

Get whether this instance will actually keep annotations.

Returns:boolean: true iff annotations are being kept

assertCursor	back to summary
public void assertCursor(int expectedCursor) Implements org.droidparts.dexmaker.dx.util.Output.assertCursor. Doc from org.droidparts.dexmaker.dx.util.Output.assertCursor. Asserts that the cursor is the given value. Parameters expectedCursor:int the expected cursor value

assertCursor

back to summary

public void assertCursor(int expectedCursor)

Implements org.droidparts.dexmaker.dx.util.Output.assertCursor.

Doc from org.droidparts.dexmaker.dx.util.Output.assertCursor.

Asserts that the cursor is the given value.

Parameters

expectedCursor:int: the expected cursor value

enableAnnotations back to summary

enableAnnotations	back to summary
public void enableAnnotations(int annotationWidth, boolean verbose) Indicates that this instance should keep annotations. This method may be called only once per instance, and only before any data has been written to the it. Parameters annotationWidth:int `>= 40;` the desired maximum annotation width verbose:boolean whether or not to indicate verbose annotations

public void enableAnnotations(int annotationWidth, boolean verbose)

Indicates that this instance should keep annotations. This method may be called only once per instance, and only before any data has been written to the it.

Parameters

annotationWidth:int: >= 40; the desired maximum annotation width
verbose:boolean: whether or not to indicate verbose annotations

endAnnotation back to summary

endAnnotation	back to summary
public void endAnnotation() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.endAnnotation. Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.endAnnotation. End the most recent annotation. Subsequent output will be unannotated, until the next call to `annotate`.

public void endAnnotation()

Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.endAnnotation.

Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.endAnnotation.

End the most recent annotation. Subsequent output will be unannotated, until the next call to annotate.

ensureCapacity back to summary

ensureCapacity	back to summary
private void ensureCapacity(int desiredSize) Reallocates the underlying array if necessary. Calls to this method should be guarded by a test of `stretchy`. Parameters desiredSize:int `>= 0;` the desired minimum total size of the array

private void ensureCapacity(int desiredSize)

Reallocates the underlying array if necessary. Calls to this method should be guarded by a test of stretchy.

Parameters

desiredSize:int: >= 0; the desired minimum total size of the array

finishAnnotating	back to summary
public void finishAnnotating() Finishes up annotation processing. This closes off any open annotations and removes annotations that don't refer to written data.

getAnnotationWidth back to summary

getAnnotationWidth	back to summary
public int getAnnotationWidth() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.getAnnotationWidth. Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.getAnnotationWidth. Get the maximum width of the annotated output. This is advisory: Implementations of this interface are encouraged to deal with too-wide output, but annotaters are encouraged to attempt to avoid exceeding the indicated width. Returns:int `>= 1;` the maximum width

public int getAnnotationWidth()

Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.getAnnotationWidth.

Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.getAnnotationWidth.

Get the maximum width of the annotated output. This is advisory: Implementations of this interface are encouraged to deal with too-wide output, but annotaters are encouraged to attempt to avoid exceeding the indicated width.

Returns:int: >= 1; the maximum width

getArray back to summary

getArray	back to summary
public byte[] getArray() Gets the underlying `byte[]` of this instance, which may be larger than the number of bytes written Returns:byte[] `non-null;` the `byte[]` See Also `toByteArray`

public byte[] getArray()

Gets the underlying byte[] of this instance, which may be larger than the number of bytes written

Returns:byte[]: non-null; the byte[]
See Also: toByteArray

getCursor back to summary

getCursor	back to summary
public int getCursor() Implements org.droidparts.dexmaker.dx.util.Output.getCursor. Doc from org.droidparts.dexmaker.dx.util.Output.getCursor. Gets the current cursor position. This is the same as the number of bytes written to this instance. Returns:int `>= 0;` the cursor position

public int getCursor()

Implements org.droidparts.dexmaker.dx.util.Output.getCursor.

Doc from org.droidparts.dexmaker.dx.util.Output.getCursor.

Gets the current cursor position. This is the same as the number of bytes written to this instance.

Returns:int: >= 0; the cursor position

isVerbose back to summary

isVerbose	back to summary
public boolean isVerbose() Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.isVerbose. Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.isVerbose. Get whether this instance is intended to keep verbose annotations. Annotators may use the result of calling this method to inform their annotation activity. Returns:boolean `true` iff annotations are to be verbose

public boolean isVerbose()

Implements org.droidparts.dexmaker.dx.util.AnnotatedOutput.isVerbose.

Doc from org.droidparts.dexmaker.dx.util.AnnotatedOutput.isVerbose.

Get whether this instance is intended to keep verbose annotations. Annotators may use the result of calling this method to inform their annotation activity.

Returns:boolean: true iff annotations are to be verbose

throwBounds	back to summary
private static void throwBounds() Throws the excpetion for when an attempt is made to write past the end of the instance.

toByteArray back to summary

toByteArray	back to summary
public byte[] toByteArray() Constructs and returns a new `byte[]` that contains the written contents exactly (that is, with no extra unwritten bytes at the end). Returns:byte[] `non-null;` an appropriately-constructed array See Also `getArray`

public byte[] toByteArray()

Constructs and returns a new byte[] that contains the written contents exactly (that is, with no extra unwritten bytes at the end).

Returns:byte[]: non-null; an appropriately-constructed array
See Also: getArray

write back to summary

write	back to summary
public void write(ByteArray bytes) Implements org.droidparts.dexmaker.dx.util.Output.write. Doc from org.droidparts.dexmaker.dx.util.Output.write. Writes a `ByteArray` to this instance. Parameters bytes:ByteArray `non-null;` the array to write

public void write(ByteArray bytes)

Implements org.droidparts.dexmaker.dx.util.Output.write.

Doc from org.droidparts.dexmaker.dx.util.Output.write.

Writes a ByteArray to this instance.

Parameters

bytes:ByteArray: non-null; the array to write

write back to summary

write	back to summary
public void write(byte[] bytes, int offset, int length) Implements org.droidparts.dexmaker.dx.util.Output.write. Doc from org.droidparts.dexmaker.dx.util.Output.write. Writes a portion of a `byte[]` to this instance. Parameters bytes:byte[] `non-null;` the array to write offset:int `>= 0;` offset into `bytes` for the first byte to write length:int `>= 0;` number of bytes to write

public void write(byte[] bytes, int offset, int length)

Implements org.droidparts.dexmaker.dx.util.Output.write.

Doc from org.droidparts.dexmaker.dx.util.Output.write.

Writes a portion of a byte[] to this instance.

Parameters

bytes:byte[]: non-null; the array to write
offset:int: >= 0; offset into bytes for the first byte to write
length:int: >= 0; number of bytes to write

write back to summary

write	back to summary
public void write(byte[] bytes) Implements org.droidparts.dexmaker.dx.util.Output.write. Doc from org.droidparts.dexmaker.dx.util.Output.write. Writes a `byte[]` to this instance. This is just a convenient shorthand for `write(bytes, 0, bytes.length)`. Parameters bytes:byte[] `non-null;` the array to write

public void write(byte[] bytes)

Implements org.droidparts.dexmaker.dx.util.Output.write.

Doc from org.droidparts.dexmaker.dx.util.Output.write.

Writes a byte[] to this instance. This is just a convenient shorthand for write(bytes, 0, bytes.length).

Parameters

bytes:byte[]: non-null; the array to write

writeAnnotationsTo back to summary

writeAnnotationsTo	back to summary
public void writeAnnotationsTo(Writer out) throws IOException Writes the annotated content of this instance to the given writer. Parameters out:Writer `non-null;` where to write to

public void writeAnnotationsTo(Writer out) throws IOException

Writes the annotated content of this instance to the given writer.

Parameters

out:Writer: non-null; where to write to

writeByte	back to summary
public void writeByte(int value) Implements org.droidparts.dexmaker.dx.util.Output.writeByte, org.droidparts.dexmaker.dx.util.ByteOutput.writeByte. Doc from org.droidparts.dexmaker.dx.util.ByteOutput.writeByte. Writes a byte. Parameters value:int Doc from org.droidparts.dexmaker.dx.util.Output.writeByte. the value to write; all but the low 8 bits are ignored

writeByte

back to summary

public void writeByte(int value)

Implements org.droidparts.dexmaker.dx.util.Output.writeByte, org.droidparts.dexmaker.dx.util.ByteOutput.writeByte.

Doc from org.droidparts.dexmaker.dx.util.ByteOutput.writeByte.

Writes a byte.

Parameters

value:int

Doc from org.droidparts.dexmaker.dx.util.Output.writeByte.

the value to write; all but the low 8 bits are ignored

writeInt back to summary

writeInt	back to summary
public void writeInt(int value) Implements org.droidparts.dexmaker.dx.util.Output.writeInt. Doc from org.droidparts.dexmaker.dx.util.Output.writeInt. Writes an `int` to this instance. Parameters value:int the value to write

public void writeInt(int value)

Implements org.droidparts.dexmaker.dx.util.Output.writeInt.

Doc from org.droidparts.dexmaker.dx.util.Output.writeInt.

Writes an int to this instance.

Parameters

value:int: the value to write

writeLong back to summary

writeLong	back to summary
public void writeLong(long value) Implements org.droidparts.dexmaker.dx.util.Output.writeLong. Doc from org.droidparts.dexmaker.dx.util.Output.writeLong. Writes a `long` to this instance. Parameters value:long the value to write

public void writeLong(long value)

Implements org.droidparts.dexmaker.dx.util.Output.writeLong.

Doc from org.droidparts.dexmaker.dx.util.Output.writeLong.

Writes a long to this instance.

Parameters

value:long: the value to write

writeShort back to summary

writeShort	back to summary
public void writeShort(int value) Implements org.droidparts.dexmaker.dx.util.Output.writeShort. Doc from org.droidparts.dexmaker.dx.util.Output.writeShort. Writes a `short` to this instance. Parameters value:int the value to write; all but the low 16 bits are ignored

public void writeShort(int value)

Implements org.droidparts.dexmaker.dx.util.Output.writeShort.

Doc from org.droidparts.dexmaker.dx.util.Output.writeShort.

Writes a short to this instance.

Parameters

value:int: the value to write; all but the low 16 bits are ignored

writeSleb128 back to summary

writeSleb128	back to summary
public int writeSleb128(int value) Implements org.droidparts.dexmaker.dx.util.Output.writeSleb128. Doc from org.droidparts.dexmaker.dx.util.Output.writeSleb128. Writes a DWARFv3-style unsigned LEB128 integer. For details, see the "Dalvik Executable Format" document or DWARF v3 section 7.6. Parameters value:int value to write Returns:int `1..5;` the number of bytes actually written

public int writeSleb128(int value)

Implements org.droidparts.dexmaker.dx.util.Output.writeSleb128.

Doc from org.droidparts.dexmaker.dx.util.Output.writeSleb128.

Writes a DWARFv3-style unsigned LEB128 integer. For details, see the "Dalvik Executable Format" document or DWARF v3 section 7.6.

Parameters

value:int: value to write

Returns:int

1..5; the number of bytes actually written

writeUleb128 back to summary

writeUleb128	back to summary
public int writeUleb128(int value) Implements org.droidparts.dexmaker.dx.util.Output.writeUleb128. Doc from org.droidparts.dexmaker.dx.util.Output.writeUleb128. Writes a DWARFv3-style unsigned LEB128 integer. For details, see the "Dalvik Executable Format" document or DWARF v3 section 7.6. Parameters value:int value to write, treated as an unsigned value Returns:int `1..5;` the number of bytes actually written

public int writeUleb128(int value)

Implements org.droidparts.dexmaker.dx.util.Output.writeUleb128.

Doc from org.droidparts.dexmaker.dx.util.Output.writeUleb128.

Writes a DWARFv3-style unsigned LEB128 integer. For details, see the "Dalvik Executable Format" document or DWARF v3 section 7.6.

Parameters

value:int: value to write, treated as an unsigned value

Returns:int

1..5; the number of bytes actually written

writeZeroes back to summary

writeZeroes	back to summary
public void writeZeroes(int count) Implements org.droidparts.dexmaker.dx.util.Output.writeZeroes. Doc from org.droidparts.dexmaker.dx.util.Output.writeZeroes. Writes the given number of `0` bytes. Parameters count:int `>= 0;` the number of zeroes to write

public void writeZeroes(int count)

Implements org.droidparts.dexmaker.dx.util.Output.writeZeroes.

Doc from org.droidparts.dexmaker.dx.util.Output.writeZeroes.

Writes the given number of 0 bytes.

Parameters

count:int: >= 0; the number of zeroes to write

org.droidparts.dexmaker.dx.util back to summary

private Class ByteArrayAnnotatedOutput.Annotation

Class Inheritance

extends Object

java.lang.Object
org.droidparts.dexmaker.dx.util.ByteArrayAnnotatedOutput.Annotation

Annotation on output.

Field Summary

Modifier and Type	Field and Description
private int	end `>= 0;` end of annotated range (exclusive); `Integer.MAX_VALUE` if unclosed
private final int	start `>= 0;` start of annotated range (inclusive)
private final String	text `non-null;` annotation text

Constructor Summary

Access	Constructor and Description
public	Annotation(int `>= 0;` start of annotated range start, int `>= start;` end of annotated range (exclusive) or `Integer.MAX_VALUE` if unclosed end, String `non-null;` annotation text text) Constructs an instance.
public	Annotation(int `>= 0;` start of annotated range start, String `non-null;` annotation text text) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the end getEnd() Gets the end.
public int	Returns: the start getStart() Gets the start.
public String	Returns: `non-null;` the text getText() Gets the text.
public void	setEnd(int `>= start;` the end end) Sets the end as given.
public void	setEndIfUnset(int `>= start;` the end end) Sets the end as given, but only if the instance is unclosed; otherwise, do nothing.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

end	back to summary
private int end `>= 0;` end of annotated range (exclusive); `Integer.MAX_VALUE` if unclosed

start	back to summary
private final int start `>= 0;` start of annotated range (inclusive)

text	back to summary
private final String text `non-null;` annotation text

Constructor Detail

Annotation back to summary

Annotation	back to summary
public Annotation(int start, int end, String text) Constructs an instance. Parameters start:int `>= 0;` start of annotated range end:int `>= start;` end of annotated range (exclusive) or `Integer.MAX_VALUE` if unclosed text:String `non-null;` annotation text

public Annotation(int start, int end, String text)

Constructs an instance.

Parameters

start:int: >= 0; start of annotated range
end:int: >= start; end of annotated range (exclusive) or Integer.MAX_VALUE if unclosed
text:String: non-null; annotation text

Annotation back to summary

Annotation	back to summary
public Annotation(int start, String text) Constructs an instance. It is initally unclosed. Parameters start:int `>= 0;` start of annotated range text:String `non-null;` annotation text

public Annotation(int start, String text)

Constructs an instance. It is initally unclosed.

Parameters

start:int: >= 0; start of annotated range
text:String: non-null; annotation text

Method Detail

getEnd

back to summary

public int getEnd()

Gets the end.

Returns:int: the end

getStart

back to summary

public int getStart()

Gets the start.

Returns:int: the start

getText back to summary

public String getText()

Gets the text.

Returns:String: non-null; the text

setEnd back to summary

public void setEnd(int end)

Sets the end as given.

Parameters

end:int: >= start; the end

setEndIfUnset back to summary

public void setEndIfUnset(int end)

Sets the end as given, but only if the instance is unclosed; otherwise, do nothing.

Parameters

end:int: >= start; the end

public final Class ByteArrayAnnotatedOutput

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ByteArrayAnnotatedOutput.Annotation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail