Modifier and Type	Class and Description
public static interface	ByteArray.GetCursor Helper interface that allows one to get the cursor (of a stream).
public static class	ByteArray.MyDataInputStream Helper class for `makeDataInputStream`.
public class	ByteArray.MyInputStream Helper class for `makeInputStream`, which implements the stream functionality.

Modifier and Type	Field and Description
private final byte[]	bytes `non-null;` underlying array
private final int	size `>= 0, <= bytes.length`; size computed as `end - start` (in the constructor)
private final int	start `>= 0`; start index of the slice (inclusive)

Access	Constructor and Description
public	ByteArray(byte[] `non-null;` the underlying array bytes, int `>= 0;` start index of the slice (inclusive) start, int `>= start, <= bytes.length;` end index of the slice (exclusive) end) Constructs an instance.
public	ByteArray(byte[] `non-null;` the underlying array bytes) Constructs an instance from an entire `byte[]`.

Method Summary

Modifier and Type	Method and Description
private void	checkOffsets(int start offset (inclusive) s, int end offset (exclusive) e) Checks a range of offsets for validity, throwing if invalid.
public int	Returns: `signed byte` at that offset getByte(int `>= 0, < size();` offset to fetch off) Gets the `signed byte` value at a particular offset.
private int	Returns: byte at that offset getByte0(int offset to fetch off) Gets the `signed byte` value at the given offset, without doing any argument checking.
public void	getBytes(byte[] `non-null;` array to hold the output out, int `non-null;` index into `out` for the first byte of output offset) Copies the contents of this instance into the given raw `byte[]` at the given offset.
public int	Returns: `signed int` at that offset getInt(int `>= 0, < (size() - 3);` offset to fetch off) Gets the `signed int` value at a particular offset.
public long	Returns: `signed int` at that offset getLong(int `>= 0, < (size() - 7);` offset to fetch off) Gets the `signed long` value at a particular offset.
public int	Returns: `signed short` at that offset getShort(int `>= 0, < (size() - 1);` offset to fetch off) Gets the `signed short` value at a particular offset.
public int	Returns: `unsigned byte` at that offset getUnsignedByte(int `>= 0, < size();` offset to fetch off) Gets the `unsigned byte` value at a particular offset.
private int	Returns: byte at that offset getUnsignedByte0(int offset to fetch off) Gets the `unsigned byte` value at the given offset, without doing any argument checking.
public int	Returns: `unsigned short` at that offset getUnsignedShort(int `>= 0, < (size() - 1);` offset to fetch off) Gets the `unsigned short` value at a particular offset.
public ByteArray.MyDataInputStream	Returns: `non-null;` an appropriately-constructed `DataInputStream` instance makeDataInputStream() Gets a `DataInputStream` that reads from this instance, with the cursor starting at the beginning of this instance's data Note The returned instance may be cast to `GetCursor` if needed.
public ByteArray.MyInputStream	Returns: `non-null;` an appropriately-constructed `InputStream` instancex makeInputStream() Gets a `InputStream` that reads from this instance, with the cursor starting at the beginning of this instance's data Note The returned instance may be cast to `GetCursor` if needed.
public int	Returns: `>= 0;` the size size() Gets the size of the array, in bytes.
public ByteArray	Returns: `non-null;` the slice slice(int `>= 0;` start index of the slice (inclusive) start, int `>= start, <= size();` end index of the slice (exclusive) end) Returns a slice (that is, a sub-array) of this instance.
public int	Returns: corresponding offset into `bytes` underlyingOffset(int offset into this instance offset, byte[] `non-null;` (alleged) underlying array bytes) Returns the offset into the given array represented by the given offset into this instance.

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

bytes	back to summary
private final byte[] bytes `non-null;` underlying array

size	back to summary
private final int size `>= 0, <= bytes.length`; size computed as `end - start` (in the constructor)

start	back to summary
private final int start `>= 0`; start index of the slice (inclusive)

Constructor Detail

ByteArray back to summary

ByteArray	back to summary
public ByteArray(byte[] bytes, int start, int end) Constructs an instance. Parameters bytes:byte[] `non-null;` the underlying array start:int `>= 0;` start index of the slice (inclusive) end:int `>= start, <= bytes.length;` end index of the slice (exclusive)

public ByteArray(byte[] bytes, int start, int end)

Constructs an instance.

Parameters

bytes:byte[]: non-null; the underlying array
start:int: >= 0; start index of the slice (inclusive)
end:int: >= start, <= bytes.length; end index of the slice (exclusive)

ByteArray back to summary

ByteArray	back to summary
public ByteArray(byte[] bytes) Constructs an instance from an entire `byte[]`. Parameters bytes:byte[] `non-null;` the underlying array

public ByteArray(byte[] bytes)

Constructs an instance from an entire byte[].

Parameters

bytes:byte[]: non-null; the underlying array

Method Detail

checkOffsets	back to summary
private void checkOffsets(int s, int e) Checks a range of offsets for validity, throwing if invalid. Parameters s:int start offset (inclusive) e:int end offset (exclusive)

checkOffsets

back to summary

private void checkOffsets(int s, int e)

Checks a range of offsets for validity, throwing if invalid.

Parameters

s:int: start offset (inclusive)
e:int: end offset (exclusive)

getByte back to summary

getByte	back to summary
public int getByte(int off) Gets the `signed byte` value at a particular offset. Parameters off:int `>= 0, < size();` offset to fetch Returns:int `signed byte` at that offset

public int getByte(int off)

Gets the signed byte value at a particular offset.

Parameters

off:int: >= 0, < size(); offset to fetch

Returns:int

signed byte at that offset

getByte0 back to summary

getByte0	back to summary
private int getByte0(int off) Gets the `signed byte` value at the given offset, without doing any argument checking. Parameters off:int offset to fetch Returns:int byte at that offset

private int getByte0(int off)

Gets the signed byte value at the given offset, without doing any argument checking.

Parameters

off:int: offset to fetch

Returns:int

byte at that offset

getBytes back to summary

getBytes	back to summary
public void getBytes(byte[] out, int offset) Copies the contents of this instance into the given raw `byte[]` at the given offset. The given array must be large enough. Parameters out:byte[] `non-null;` array to hold the output offset:int `non-null;` index into `out` for the first byte of output

public void getBytes(byte[] out, int offset)

Copies the contents of this instance into the given raw byte[] at the given offset. The given array must be large enough.

Parameters

out:byte[]: non-null; array to hold the output
offset:int: non-null; index into out for the first byte of output

getInt back to summary

getInt	back to summary
public int getInt(int off) Gets the `signed int` value at a particular offset. Parameters off:int `>= 0, < (size() - 3);` offset to fetch Returns:int `signed int` at that offset

public int getInt(int off)

Gets the signed int value at a particular offset.

Parameters

off:int: >= 0, < (size() - 3); offset to fetch

Returns:int

signed int at that offset

getLong back to summary

getLong	back to summary
public long getLong(int off) Gets the `signed long` value at a particular offset. Parameters off:int `>= 0, < (size() - 7);` offset to fetch Returns:long `signed int` at that offset

public long getLong(int off)

Gets the signed long value at a particular offset.

Parameters

off:int: >= 0, < (size() - 7); offset to fetch

Returns:long

signed int at that offset

getShort back to summary

getShort	back to summary
public int getShort(int off) Gets the `signed short` value at a particular offset. Parameters off:int `>= 0, < (size() - 1);` offset to fetch Returns:int `signed short` at that offset

public int getShort(int off)

Gets the signed short value at a particular offset.

Parameters

off:int: >= 0, < (size() - 1); offset to fetch

Returns:int

signed short at that offset

getUnsignedByte back to summary

getUnsignedByte	back to summary
public int getUnsignedByte(int off) Gets the `unsigned byte` value at a particular offset. Parameters off:int `>= 0, < size();` offset to fetch Returns:int `unsigned byte` at that offset

public int getUnsignedByte(int off)

Gets the unsigned byte value at a particular offset.

Parameters

off:int: >= 0, < size(); offset to fetch

Returns:int

unsigned byte at that offset

getUnsignedByte0 back to summary

getUnsignedByte0	back to summary
private int getUnsignedByte0(int off) Gets the `unsigned byte` value at the given offset, without doing any argument checking. Parameters off:int offset to fetch Returns:int byte at that offset

private int getUnsignedByte0(int off)

Gets the unsigned byte value at the given offset, without doing any argument checking.

Parameters

off:int: offset to fetch

Returns:int

byte at that offset

getUnsignedShort back to summary

getUnsignedShort	back to summary
public int getUnsignedShort(int off) Gets the `unsigned short` value at a particular offset. Parameters off:int `>= 0, < (size() - 1);` offset to fetch Returns:int `unsigned short` at that offset

public int getUnsignedShort(int off)

Gets the unsigned short value at a particular offset.

Parameters

off:int: >= 0, < (size() - 1); offset to fetch

Returns:int

unsigned short at that offset

makeDataInputStream back to summary

makeDataInputStream	back to summary
public ByteArray.MyDataInputStream makeDataInputStream() Gets a `DataInputStream` that reads from this instance, with the cursor starting at the beginning of this instance's data Note The returned instance may be cast to `GetCursor` if needed. Returns:ByteArray.MyDataInputStream `non-null;` an appropriately-constructed `DataInputStream` instance

public ByteArray.MyDataInputStream makeDataInputStream()

Gets a DataInputStream that reads from this instance, with the cursor starting at the beginning of this instance's data

Note

The returned instance may be cast to GetCursor if needed.

Returns:ByteArray.MyDataInputStream: non-null; an appropriately-constructed DataInputStream instance

makeInputStream back to summary

makeInputStream	back to summary
public ByteArray.MyInputStream makeInputStream() Gets a `InputStream` that reads from this instance, with the cursor starting at the beginning of this instance's data Note The returned instance may be cast to `GetCursor` if needed. Returns:ByteArray.MyInputStream `non-null;` an appropriately-constructed `InputStream` instancex

public ByteArray.MyInputStream makeInputStream()

Gets a InputStream that reads from this instance, with the cursor starting at the beginning of this instance's data

Note

The returned instance may be cast to GetCursor if needed.

Returns:ByteArray.MyInputStream: non-null; an appropriately-constructed InputStream instancex

size back to summary

size	back to summary
public int size() Gets the size of the array, in bytes. Returns:int `>= 0;` the size

public int size()

Gets the size of the array, in bytes.

Returns:int: >= 0; the size

slice back to summary

slice	back to summary
public ByteArray slice(int start, int end) Returns a slice (that is, a sub-array) of this instance. Parameters start:int `>= 0;` start index of the slice (inclusive) end:int `>= start, <= size();` end index of the slice (exclusive) Returns:ByteArray `non-null;` the slice

public ByteArray slice(int start, int end)

Returns a slice (that is, a sub-array) of this instance.

Parameters

start:int: >= 0; start index of the slice (inclusive)
end:int: >= start, <= size(); end index of the slice (exclusive)

Returns:ByteArray

non-null; the slice

underlyingOffset back to summary

underlyingOffset	back to summary
public int underlyingOffset(int offset, byte[] bytes) Returns the offset into the given array represented by the given offset into this instance. Parameters offset:int offset into this instance bytes:byte[] `non-null;` (alleged) underlying array Returns:int corresponding offset into `bytes` Exceptions IllegalArgumentException: thrown if `bytes` is not the underlying array of this instance

public int underlyingOffset(int offset, byte[] bytes)

Returns the offset into the given array represented by the given offset into this instance.

Parameters

offset:int: offset into this instance
bytes:byte[]: non-null; (alleged) underlying array

Returns:int

corresponding offset into bytes

Exceptions

IllegalArgumentException:: thrown if bytes is not the underlying array of this instance

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

public Interface ByteArray.GetCursor

Helper interface that allows one to get the cursor (of a stream).

Method Summary

Modifier and Type	Method and Description
public int	Returns: `0..size();` the cursor getCursor() Gets the current cursor.

Method Detail

getCursor back to summary

getCursor	back to summary
public int getCursor() Gets the current cursor. Returns:int `0..size();` the cursor

public int getCursor()

Gets the current cursor.

Returns:int: 0..size(); the cursor

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

public Class ByteArray.MyDataInputStream

Class Inheritance

extends DataInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
java.io.DataInputStream
org.droidparts.dexmaker.dx.util.ByteArray.MyDataInputStream

Helper class for makeDataInputStream. This is used simply so that the cursor of a wrapped MyInputStream instance may be easily determined.

Field Summary

Modifier and Type	Field and Description
private final ByteArray.MyInputStream	wrapped `non-null;` the underlying `MyInputStream`

Constructor Summary

Access	Constructor and Description
public	MyDataInputStream(ByteArray.MyInputStream wrapped)

Method Summary

Inherited from java.io.DataInputStream:: read read readBoolean readByte readChar readDouble readFloat readFully readFully readInt readLine readLong readShort readUnsignedByte readUnsignedShort readUTF readUTF skipBytes

Field Detail

wrapped	back to summary
private final ByteArray.MyInputStream wrapped `non-null;` the underlying `MyInputStream`

Constructor Detail

MyDataInputStream	back to summary
public MyDataInputStream(ByteArray.MyInputStream wrapped)

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

public Class ByteArray.MyInputStream

Class Inheritance

extends InputStream

java.lang.Object
java.io.InputStream
org.droidparts.dexmaker.dx.util.ByteArray.MyInputStream

Helper class for makeInputStream, which implements the stream functionality.

Field Summary

Modifier and Type	Field and Description
private int	cursor 0..size; the cursor
private int	mark 0..size; the mark

Constructor Summary

Access	Constructor and Description
public	MyInputStream()

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public void	mark(int the maximum limit of bytes that can be read before the mark position becomes invalid. reserve) Overrides java.io.InputStream.mark. Marks the current position in this input stream.
public boolean	markSupported() Overrides java.io.InputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. arr, int the start offset in array `b` at which the data is written. offset, int the maximum number of bytes to read. length) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public void	reset() Overrides java.io.InputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.

Inherited from java.io.InputStream:: close nullInputStream read readAllBytes readNBytes readNBytes skip skipNBytes transferTo

Field Detail

cursor	back to summary
private int cursor 0..size; the cursor

mark	back to summary
private int mark 0..size; the mark

Constructor Detail

MyInputStream	back to summary
public MyInputStream()

Method Detail

available back to summary

available	back to summary
public int available() Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream.

public int available()

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int: an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

mark back to summary

mark	back to summary
public void mark(int reserve) Overrides java.io.InputStream.mark. Doc from java.io.InputStream.mark. Marks the current position in this input stream. A subsequent call to the `reset` method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The `readlimit` arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated. The general contract of `mark` is that, if the method `markSupported` returns `true`, the stream somehow remembers all the bytes read after the call to `mark` and stands ready to supply those same bytes again if and whenever the method `reset` is called. However, the stream is not required to remember any data at all if more than `readlimit` bytes are read from the stream before `reset` is called. Marking a closed stream should not have any effect on the stream. Parameters reserve:int the maximum limit of bytes that can be read before the mark position becomes invalid.

public void mark(int reserve)

Overrides java.io.InputStream.mark.

Doc from java.io.InputStream.mark.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than readlimit bytes are read from the stream before reset is called.

Marking a closed stream should not have any effect on the stream.

Parameters

reserve:int: the maximum limit of bytes that can be read before the mark position becomes invalid.

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.InputStream.markSupported. Doc from java.io.InputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods. Whether or not `mark` and `reset` are supported is an invariant property of a particular input stream instance. Returns:boolean `true` if this stream instance supports the mark and reset methods; `false` otherwise.

public boolean markSupported()

Overrides java.io.InputStream.markSupported.

Doc from java.io.InputStream.markSupported.

Tests if this input stream supports the mark and reset methods. Whether or not mark and reset are supported is an invariant property of a particular input stream instance.

Returns:boolean: true if this stream instance supports the mark and reset methods; false otherwise.

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] arr, int offset, int length) Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters arr:byte[] the buffer into which the data is read. offset:int the start offset in array `b` at which the data is written. length:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached.

public int read(byte[] arr, int offset, int length)

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

arr:byte[]: the buffer into which the data is read.
offset:int: the start offset in array b at which the data is written.
length:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

reset back to summary

reset	back to summary
public void reset() Overrides java.io.InputStream.reset. Doc from java.io.InputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream. The general contract of `reset` is: If the method `markSupported` returns `true`, then: If the method `mark` has not been called since the stream was created, or the number of bytes read from the stream since `mark` was last called is larger than the argument to `mark` at that last call, then an `IOException` might be thrown. If such an `IOException` is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to `mark` (or since the start of the file, if `mark` has not been called) will be resupplied to subsequent callers of the `read` method, followed by any bytes that otherwise would have been the next input data as of the time of the call to `reset`. If the method `markSupported` returns `false`, then: The call to `reset` may throw an `IOException`. If an `IOException` is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the `read` method depend on the particular type of the input stream.

public void reset()

Overrides java.io.InputStream.reset.

Doc from java.io.InputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

The general contract of reset is:

If the method markSupported returns true, then:
- If the method mark has not been called since the stream was created, or the number of bytes read from the stream since mark was last called is larger than the argument to mark at that last call, then an IOException might be thrown.
- If such an IOException is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to mark (or since the start of the file, if mark has not been called) will be resupplied to subsequent callers of the read method, followed by any bytes that otherwise would have been the next input data as of the time of the call to reset.
If the method markSupported returns false, then:
- The call to reset may throw an IOException.
- If an IOException is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the read method depend on the particular type of the input stream.

public final Class ByteArray

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ByteArray.GetCursor

Method Summary

Method Detail

public Class ByteArray.MyDataInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

public Class ByteArray.MyInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail