HexDumpDocument

Class Overview

A text document used to represent binary data as a standardized hex-dump text blob.

Example:

 00000000  05 4B 03 04 14 00 08 08 08 00 11 58 73 45 63 4A  .K.........XsEcJ
 00000010  95 6A 29 18 01 00 9D 62 03 00 14 00 00 00 4D 45  .j)....b......ME
 ...
 

Each line represents 16 bytes of data. The input contents can have up to 2^63 bytes. (Note that addresses in the left-most column will be encoded as 32-bit hex values for the contents has less than 2^31 bytes). The right-most column is an ASCII representation of the associated binary data; non ASCII characters are represented as dots.

Important: the default addressing scheme used by this document is unlikely to be consistent with other units'. Addresses start with the reserved '@' prefix, and are in the form @????h, where XXX represent an hexadecimal offset within the input. Implementors are free to override this scheme if they wish to make it consistent with addressing used in other documents produced by a same unit. This note is relevant only if the document is produced by a unit.

Note: this document is not serializable; it should not be used in a list of persisted presentations.

Summary

[Expand] Inherited Fields
From class com.pnfsoftware.jeb.util.events.EventSource public static final AtomicInteger onEventCallCount

Public Constructors
	HexDumpDocument(IInput input, IUnit unit) Create a new hexdump document to represent the input binary data.
	HexDumpDocument(IInput input)

Public Methods
ICoordinates	addressToCoordinates(String address, CoordinatesConversionPrecision precision) Precision is not used - Use an exact address
String	coordinatesToAddress(ICoordinates coordinates, AddressConversionPrecision precision) Convert document-specific text coordinates to a unit-specific address.
void	dispose() The default implementation does nothing.
long	getAnchorCount()
ITextDocumentPart	getDocumentPart(long anchorId, int linesAfter, int linesBefore)
IInput	getInput() Retrieve the input data.

[Expand] Inherited Methods
From class com.pnfsoftware.jeb.core.output.text.impl.AbstractTextDocument final ICoordinates addressToCoordinates(String address) Convert a unit-specific address to document-specific text coordinates. ICoordinates addressToCoordinates(String address, CoordinatesConversionPrecision precision) Precision is not used - Use an exact address final String coordinatesToAddress(ICoordinates coordinates) Convert document-specific text coordinates to a unit-specific address using a default conversion precision. String coordinatesToAddress(ICoordinates coordinates, AddressConversionPrecision precision) Convert document-specific text coordinates to a unit-specific address. void dispose() The default implementation does nothing. String format() Format this text document. ITextDocumentPart getDocumentPart(long anchorId, int linesAfter) Retrieve a document part. ITextDocumentPart getDocumentPart2(long anchorBegin, long anchorEnd) The default implementation throws. long getFirstAnchor() The default implementation returns 0. long getInitialAnchor() The default implementation returns the first anchor as the initial anchor. IPropertyManager getPropertyManager() The default implementation returns null. String toString() boolean useDisplayLineNumber() Specify if coordinatesToAddress(ICoordinates, AddressConversionPrecision) and addressToCoordinates(String, CoordinatesConversionPrecision) will use the anchor inner value or should display as a text editor (where first line is line 1). boolean useLineDelta() Specify if coordinatesToAddress(ICoordinates, AddressConversionPrecision) and addressToCoordinates(String, CoordinatesConversionPrecision) will use the line Delta.
From class com.pnfsoftware.jeb.util.events.EventSource void addListener(IEventListener listener) Register a listener. int countListeners() Get the numbers of objects listening to this event source. List<IEventListener> getListeners() Get a copy of the list of listeners. IEventSource getParentSource() Get the parent source. void insertListener(int index, IEventListener listener) Register a listener. void notifyListeners(Event e) void notifyListeners(IEvent e) Notify listeners that an event has occurred. void notifyListeners(Event e, boolean notifyParent) static IEventListener relay(IEventSource origin, IEventSource proxy) Relay events issued from an origin to the listeners of a proxy. void removeListener(IEventListener listener) Unregister a listener. void setParentSource(IEventSource parentSource) Set a parent source.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface com.pnfsoftware.jeb.core.output.IGenericDocument abstract void dispose() Dispose of resources and handles used by this document. abstract IPropertyManager getPropertyManager() Provide the optional property manager to customize rendering of the document. abstract IUnit getUnit() If available, retrieve the unit that backs up this document.
From interface com.pnfsoftware.jeb.core.output.text.ITextDocument abstract ICoordinates addressToCoordinates(String address) Convert a unit-specific address to document-specific text coordinates. abstract ICoordinates addressToCoordinates(String address, CoordinatesConversionPrecision precision) Convert a unit-specific address to document-specific text coordinates. abstract String coordinatesToAddress(ICoordinates coordinates) Convert document-specific text coordinates to a unit-specific address using a default conversion precision. abstract String coordinatesToAddress(ICoordinates coordinates, AddressConversionPrecision precision) Convert document-specific text coordinates to a unit-specific address. abstract String format() Format this text document. abstract long getAnchorCount() Get the range of anchor points in the document. abstract IBinaryRepresentation getBinaryRepresentation() Retrieve a binary representation of this document. abstract ITextDocumentPart getDocumentPart(long anchorId, int linesAfter) Retrieve a document part. abstract ITextDocumentPart getDocumentPart(long anchorId, int linesAfter, int linesBefore) Retrieve a document part. abstract ITextDocumentPart getDocumentPart2(long anchorBegin, long anchorEnd) Retrieve the document part located between two anchor references. abstract long getFirstAnchor() Get the first anchor identifier of the document. abstract long getInitialAnchor() Get the anchor identifier that would represent the first logical section of a document (meaning the anchor to focus on when opening a document). abstract boolean hasBinaryRepresentation() Determine if this document offers binary representations.
From interface com.pnfsoftware.jeb.util.events.IEventSource abstract void addListener(IEventListener listener) Register a listener. abstract int countListeners() Get the numbers of objects listening to this event source. abstract List<? extends IEventListener> getListeners() Get a copy of the list of listeners. abstract IEventSource getParentSource() Get the parent source. abstract void insertListener(int index, IEventListener listener) Register a listener. abstract void notifyListeners(IEvent e) Notify listeners that an event has occurred. abstract void removeListener(IEventListener listener) Unregister a listener. abstract void setParentSource(IEventSource parentSource) Set a parent source.