Class AsciiDocument
- All Implemented Interfaces:
IGenericDocument
,ITextDocument
,IEventSource
The input data can be of any size, up to 2^63 bytes, and arbitrarily encoded. Non Ascii-printable
characters will be escaped and rendered as \x??
entities.
Similarly to HexDumpDocument
objects, these objects are not necessarily tied to units. If
related to units, and since the addressing scheme may not consistent with other documents' of
such unit, the reserved prefix '@' is used for addresses. Addresses are like:
@line,column
where line and column are 1-based.
Note: this document is not serializable; it should not be used in a list of persisted presentations.
-
Field Summary
Fields inherited from class com.pnfsoftware.jeb.util.events.EventSource
onEventCallCount
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddressToCoordinates
(String address, CoordinatesConversionPrecision precision) Precision is not used - Use an exact addresscoordinatesToAddress
(ICoordinates coordinates, AddressConversionPrecision precision) Convert document-specific text coordinates to a unit-specific address.long
Get the range of anchor points in the document.getDocumentPart
(long anchorId, int linesAfter, int linesBefore) Retrieve a document part.protected boolean
Specify ifAbstractTextDocument.coordinatesToAddress(ICoordinates, AddressConversionPrecision)
andAbstractTextDocument.addressToCoordinates(String, CoordinatesConversionPrecision)
will use the anchor inner value or should display as a text editor (where first line is line 1).protected boolean
Specify ifAbstractTextDocument.coordinatesToAddress(ICoordinates, AddressConversionPrecision)
andAbstractTextDocument.addressToCoordinates(String, CoordinatesConversionPrecision)
will use the line Delta.Methods inherited from class com.pnfsoftware.jeb.core.output.text.impl.AbstractTextDocument
addressToCoordinates, coordinatesToAddress, dispose, format, getDocumentPart, getDocumentPart2, getFirstAnchor, getInitialAnchor, getPropertyManager, toString
Methods inherited from class com.pnfsoftware.jeb.util.events.EventSource
addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, notifyListeners, notifyListeners, relay, removeListener, setParentSource
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.pnfsoftware.jeb.util.events.IEventSource
addListener, countListeners, getListeners, getParentSource, insertListener, notifyListeners, removeListener, setParentSource
Methods inherited from interface com.pnfsoftware.jeb.core.output.IGenericDocument
getUnit
Methods inherited from interface com.pnfsoftware.jeb.core.output.text.ITextDocument
getBinaryRepresentation, hasBinaryRepresentation
-
Constructor Details
-
AsciiDocument
Create a text document.- Parameters:
input
- the input data
-
-
Method Details
-
getAnchorCount
public long getAnchorCount()Description copied from interface:ITextDocument
Get the range of anchor points in the document. Returning 1 means that the document returns a single part, holding the entire contents.Note that the anchor at "
ITextDocument.getFirstAnchor()
+ITextDocument.getAnchorCount()
" is the "end" anchor (one after the last), and lies outside the document. It is not a valid anchor.- Returns:
- the count/range of anchors in this document, must be greater than zero
-
getDocumentPart
Description copied from interface:ITextDocument
Retrieve a document part. Clients call this method to retrieve a document part starting at a specific anchor, and containing the given amount of lines after and before the anchor. It is the responsibility of the implementor to sanitize the input (eg, negative number of lines, invalid anchor, etc.) and provide appropriate response (eg, truncating). It is recommended that implementors try not to raise an exception on error. In the worst case scenario, an empty document can be returned.- Parameters:
anchorId
- the anchor identifierlinesAfter
- hint lines count to return after the given anchor, could be more or lesslinesBefore
- hint lines count to return before the given anchor, could be more or less- Returns:
- a document part containing as many anchors as required to honor the client requests. If linesAfter is non-null, the first anchor within the document part may not be anchorId, but one anchor before that. THis method should return null if an invalid anchor was provided
-
useLineDelta
protected boolean useLineDelta()Description copied from class:AbstractTextDocument
Specify ifAbstractTextDocument.coordinatesToAddress(ICoordinates, AddressConversionPrecision)
andAbstractTextDocument.addressToCoordinates(String, CoordinatesConversionPrecision)
will use the line Delta. Default is true, but implementations can decide to use only one line for an anchor.- Overrides:
useLineDelta
in classAbstractTextDocument
- Returns:
-
useDisplayLineNumber
protected boolean useDisplayLineNumber()Description copied from class:AbstractTextDocument
Specify ifAbstractTextDocument.coordinatesToAddress(ICoordinates, AddressConversionPrecision)
andAbstractTextDocument.addressToCoordinates(String, CoordinatesConversionPrecision)
will use the anchor inner value or should display as a text editor (where first line is line 1). Line Delta and column offset are not modified.- Overrides:
useDisplayLineNumber
in classAbstractTextDocument
-
coordinatesToAddress
Description copied from interface:ITextDocument
Convert document-specific text coordinates to a unit-specific address.Note: The addressing scheme is unit specific, and defined by the plugin developer. Addresses should not start with the reserved '@' prefix.
- Specified by:
coordinatesToAddress
in interfaceITextDocument
- Overrides:
coordinatesToAddress
in classAbstractTextDocument
- Parameters:
coordinates
- the coordinatesprecision
- indicate the precision of the address (AddressConversionPrecision.COARSE
will return a raw address, with a faster result whileAddressConversionPrecision.FINE
will return a more precise address that can be a bit longer). IfAddressConversionPrecision.COARSE
can not be retrieved, it may return a null result, and the user will need to recall this method with another precision.- Returns:
- the address, null on error
-
addressToCoordinates
Description copied from class:AbstractTextDocument
Precision is not used - Use an exact address- Specified by:
addressToCoordinates
in interfaceITextDocument
- Overrides:
addressToCoordinates
in classAbstractTextDocument
- Parameters:
address
- a textual address- Returns:
- the text coordinates, null on error
-