AssemblyBuffer

java.lang.Object
- com.oracle.objectfile.io.AssemblyBuffer

All Implemented Interfaces:

InputDisassembler, OutputAssembler
```
public class AssemblyBuffer
extends Object
implements InputDisassembler, OutputAssembler
```
This is a wrapper for ByteBuffer which provides assembler-style operations to read and write binary data at the granularity of bytes, words etc.. Its interface is intentionally modeled on the analogous directives in the Oracle Solaris x86 assembler, as(1). "http://docs.oracle.com/cd/E26502_01/html/E28388/". Since this class supports both writing (assembling) and reading (disassembling), each assembler directive has a corresponding "read" and "write" method in this class. A note about signedness: for writing, there is no need for signed/unsigned versions of each directive. Instead, it's the caller's responsibility to pass a (signed) value whose two's complement encoding is the desired bit pattern (e.g. -1 for the 32-bit value 0xffffffff). When reading, this is more complicated: if we read a byte with value 0xff, should we return (short) 255, or (byte) -1? The latter is more consistent with the writing behavior, but also more confusing when considered in isolation. So far, this distinction has only been important when reading bytes, and we provide explicit readUbyte() and readByte() methods to cater to each requirement separately. FIXME: this should probably be expanded to cover the full range of integer data types (except long, which we're stuck with).

Field Summary

Fields
Modifier and Type Field and Description

static int INITIAL_STRING_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`INITIAL_STRING_SIZE`

Constructor Summary

Constructors
Constructor and Description

AssemblyBuffer()

AssemblyBuffer(ByteBuffer in)

AssemblyBuffer(ByteOrder order)

Constructors
Constructor and Description
`AssemblyBuffer()`
`AssemblyBuffer(ByteBuffer in)`
`AssemblyBuffer(ByteOrder order)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`align(int alignment)`
`void`	`alignRead(int alignment)`
`static InputDisassembler`	`createInputDisassembler(ByteBuffer in)`
`static OutputAssembler`	`createOutputAssembler()`
`static OutputAssembler`	`createOutputAssembler(ByteBuffer out)`
`static OutputAssembler`	`createOutputAssembler(ByteOrder order)`
`boolean`	`eof()`
`void`	`even()`
`byte[]`	`getBlob()`
`ByteBuffer`	`getBuffer()`
`ByteOrder`	`getByteOrder()`
`void`	`pop()`
`int`	`pos()`
`void`	`pushPos()`
`void`	`pushSeek(long pos)`
`void`	`pushSkip(long diff)`
`short`	`read2Byte()`
`int`	`read4Byte()`
`long`	`read8Byte()`
`byte[]`	`readBlob(int length)`
`byte`	`readByte()`
`long`	`readLEB128()`
`long`	`readQuad()`
`long`	`readSLEB128()`
`long`	`readTruncatedLong(int truncateTo)`
`char`	`readUbyte()`
`short`	`readValue()`
`String`	`readZeroTerminatedString()`
`void`	`seek(long pos)`
`void`	`setByteOrder(ByteOrder byteOrder)`
`void`	`skip(int n)`
`void`	`skip(long diff)`
`void`	`write2Byte(short i)`
`void`	`write4Byte(int w)`
`void`	`write8Byte(long w)`
`void`	`writeBCD(double f)`
`void`	`writeBlob(byte[] blob)`
`void`	`writeByte(byte b)`
`void`	`writeDouble(double f)`
`void`	`writeFloat(float f)`
`void`	`writeLEB128(long v)`
`void`	`writeQuad(long w)`
`void`	`writeSLEB128(long v)`
`void`	`writeString(String s)`
`void`	`writeStringPadded(String s, int nBytes)`
`void`	`writeTruncatedLong(long value, int truncateTo)`
`void`	`writeValue(short i)`
`void`	`writeZero(int n)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INITIAL_STRING_SIZE
```
public static final int INITIAL_STRING_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AssemblyBuffer
```
public AssemblyBuffer(ByteBuffer in)
```
  - AssemblyBuffer
```
public AssemblyBuffer(ByteOrder order)
```
  - AssemblyBuffer
```
public AssemblyBuffer()
```
- Method Detail
  - createInputDisassembler
```
public static InputDisassembler createInputDisassembler(ByteBuffer in)
```
  - createOutputAssembler
```
public static OutputAssembler createOutputAssembler(ByteBuffer out)
```
  - createOutputAssembler
```
public static OutputAssembler createOutputAssembler(ByteOrder order)
```
  - createOutputAssembler
```
public static OutputAssembler createOutputAssembler()
```
  - eof
```
public boolean eof()
```
    Specified by:
    
    eof in interface InputDisassembler
    
    Specified by:
    
    eof in interface OutputAssembler
  - seek
```
public void seek(long pos)
```
    Specified by:
    
    seek in interface InputDisassembler
    
    Specified by:
    
    seek in interface OutputAssembler
  - skip
```
public void skip(long diff)
```
    Specified by:
    
    skip in interface InputDisassembler
    
    Specified by:
    
    skip in interface OutputAssembler
  - pushSeek
```
public void pushSeek(long pos)
```
    Specified by:
    
    pushSeek in interface InputDisassembler
    
    Specified by:
    
    pushSeek in interface OutputAssembler
  - pushSkip
```
public void pushSkip(long diff)
```
    Specified by:
    
    pushSkip in interface InputDisassembler
    
    Specified by:
    
    pushSkip in interface OutputAssembler
  - pushPos
```
public void pushPos()
```
    Specified by:
    
    pushPos in interface InputDisassembler
    
    Specified by:
    
    pushPos in interface OutputAssembler
  - pop
```
public void pop()
```
    Specified by:
    
    pop in interface InputDisassembler
    
    Specified by:
    
    pop in interface OutputAssembler
  - pos
```
public int pos()
```
    Specified by:
    
    pos in interface InputDisassembler
    
    Specified by:
    
    pos in interface OutputAssembler
  - align
```
public void align(int alignment)
```
    Specified by:
    
    align in interface OutputAssembler
  - even
```
public void even()
```
    Specified by:
    
    even in interface InputDisassembler
    
    Specified by:
    
    even in interface OutputAssembler
  - writeZero
```
public void writeZero(int n)
```
    Specified by:
    
    writeZero in interface OutputAssembler
  - writeLEB128
```
public void writeLEB128(long v)
```
    Specified by:
    
    writeLEB128 in interface OutputAssembler
  - writeSLEB128
```
public void writeSLEB128(long v)
```
    Specified by:
    
    writeSLEB128 in interface OutputAssembler
  - writeBCD
```
public void writeBCD(double f)
```
    Specified by:
    
    writeBCD in interface OutputAssembler
  - writeFloat
```
public void writeFloat(float f)
```
    Specified by:
    
    writeFloat in interface OutputAssembler
  - writeDouble
```
public void writeDouble(double f)
```
    Specified by:
    
    writeDouble in interface OutputAssembler
  - writeByte
```
public void writeByte(byte b)
```
    Specified by:
    
    writeByte in interface OutputAssembler
  - write4Byte
```
public void write4Byte(int w)
```
    Specified by:
    
    write4Byte in interface OutputAssembler
  - writeBlob
```
public void writeBlob(byte[] blob)
```
    Specified by:
    
    writeBlob in interface OutputAssembler
  - write2Byte
```
public void write2Byte(short i)
```
    Specified by:
    
    write2Byte in interface OutputAssembler
  - writeValue
```
public void writeValue(short i)
```
    Specified by:
    
    writeValue in interface OutputAssembler
  - write8Byte
```
public void write8Byte(long w)
```
    Specified by:
    
    write8Byte in interface OutputAssembler
  - writeQuad
```
public void writeQuad(long w)
```
    Specified by:
    
    writeQuad in interface OutputAssembler
  - writeString
```
public void writeString(String s)
```
    Specified by:
    
    writeString in interface OutputAssembler
  - writeStringPadded
```
public void writeStringPadded(String s,
                              int nBytes)
```
    Specified by:
    
    writeStringPadded in interface OutputAssembler
  - getBuffer
```
public ByteBuffer getBuffer()
```
    Specified by:
    
    getBuffer in interface InputDisassembler
    
    Specified by:
    
    getBuffer in interface OutputAssembler
  - getBlob
```
public byte[] getBlob()
```
    Specified by:
    
    getBlob in interface OutputAssembler
  - setByteOrder
```
public void setByteOrder(ByteOrder byteOrder)
```
    Specified by:
    
    setByteOrder in interface InputDisassembler
    
    Specified by:
    
    setByteOrder in interface OutputAssembler
  - skip
```
public void skip(int n)
```
    Specified by:
    
    skip in interface InputDisassembler
    
    Specified by:
    
    skip in interface OutputAssembler
  - getByteOrder
```
public ByteOrder getByteOrder()
```
    Specified by:
    
    getByteOrder in interface InputDisassembler
    
    Specified by:
    
    getByteOrder in interface OutputAssembler
  - alignRead
```
public void alignRead(int alignment)
```
    Specified by:
    
    alignRead in interface InputDisassembler
  - read4Byte
```
public int read4Byte()
```
    Specified by:
    
    read4Byte in interface InputDisassembler
  - readByte
```
public byte readByte()
```
    Specified by:
    
    readByte in interface InputDisassembler
  - readUbyte
```
public char readUbyte()
```
    Specified by:
    
    readUbyte in interface InputDisassembler
  - read2Byte
```
public short read2Byte()
```
    Specified by:
    
    read2Byte in interface InputDisassembler
  - readValue
```
public short readValue()
```
    Specified by:
    
    readValue in interface InputDisassembler
  - read8Byte
```
public long read8Byte()
```
    Specified by:
    
    read8Byte in interface InputDisassembler
  - readQuad
```
public long readQuad()
```
    Specified by:
    
    readQuad in interface InputDisassembler
  - writeTruncatedLong
```
public void writeTruncatedLong(long value,
                               int truncateTo)
```
    Specified by:
    
    writeTruncatedLong in interface OutputAssembler
  - readTruncatedLong
```
public long readTruncatedLong(int truncateTo)
```
    Specified by:
    
    readTruncatedLong in interface InputDisassembler
  - readZeroTerminatedString
```
public String readZeroTerminatedString()
```
    Specified by:
    
    readZeroTerminatedString in interface InputDisassembler
  - readLEB128
```
public long readLEB128()
```
    Specified by:
    
    readLEB128 in interface InputDisassembler
  - readSLEB128
```
public long readSLEB128()
```
    Specified by:
    
    readSLEB128 in interface InputDisassembler
  - readBlob
```
public byte[] readBlob(int length)
```
    Specified by:
    
    readBlob in interface InputDisassembler

Class AssemblyBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INITIAL_STRING_SIZE

Constructor Detail

AssemblyBuffer

AssemblyBuffer

AssemblyBuffer

Method Detail

createInputDisassembler

createOutputAssembler

createOutputAssembler

createOutputAssembler

eof

seek

skip

pushSeek

pushSkip

pushPos

pop

pos

align

even

writeZero

writeLEB128

writeSLEB128

writeBCD

writeFloat

writeDouble

writeByte

write4Byte

writeBlob

write2Byte

writeValue

write8Byte

writeQuad

writeString

writeStringPadded

getBuffer

getBlob

setByteOrder

skip

getByteOrder

alignRead

read4Byte

readByte

readUbyte

read2Byte

readValue

read8Byte

readQuad

writeTruncatedLong

readTruncatedLong

readZeroTerminatedString

readLEB128

readSLEB128

readBlob