Class SourceCompactor
- All Implemented Interfaces:
CharStreamSource
Use one of the following methods to obtain the output:
The output text is functionally equivalent to the original source and should be rendered identically.
Compacting an entire Source
object performs a full sequential parse automatically.
-
Constructor Summary
ConstructorsConstructorDescriptionSourceCompactor
(Segment segment) Constructs a newSourceCompactor
based on the specifiedSegment
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendTo
(Appendable appendable) Appends the output to the specifiedAppendable
object.long
Returns the estimated maximum number of characters in the output, or-1
if no estimate is available.Returns the string to be used to represent a newline in the output.setNewLine
(String newLine) Sets the string to be used to represent a newline in the output.toString()
Returns the output as a string.void
Writes the output to the specifiedWriter
.
-
Constructor Details
-
SourceCompactor
Constructs a newSourceCompactor
based on the specifiedSegment
.- Parameters:
segment
- the segment containing the HTML to be compacted.
-
-
Method Details
-
writeTo
Description copied from interface:CharStreamSource
Writes the output to the specifiedWriter
.- Specified by:
writeTo
in interfaceCharStreamSource
- Parameters:
writer
- the destinationjava.io.Writer
for the output.- Throws:
IOException
- if an I/O exception occurs.
-
appendTo
Description copied from interface:CharStreamSource
Appends the output to the specifiedAppendable
object.- Specified by:
appendTo
in interfaceCharStreamSource
- Parameters:
appendable
- the destinationjava.lang.Appendable
object for the output.- Throws:
IOException
- if an I/O exception occurs.
-
getEstimatedMaximumOutputLength
public long getEstimatedMaximumOutputLength()Description copied from interface:CharStreamSource
Returns the estimated maximum number of characters in the output, or-1
if no estimate is available.The returned value should be used as a guide for efficiency purposes only, for example to set an initial
StringBuilder
capacity. There is no guarantee that the length of the output is indeed less than this value, as classes implementing this method often use assumptions based on typical usage to calculate the estimate.Although implementations of this method should never return a value less than -1, users of this method must not assume that this will always be the case. Standard practice is to interpret any negative value as meaning that no estimate is available.
- Specified by:
getEstimatedMaximumOutputLength
in interfaceCharStreamSource
- Returns:
- the estimated maximum number of characters in the output, or
-1
if no estimate is available.
-
toString
Description copied from interface:CharStreamSource
Returns the output as a string.- Specified by:
toString
in interfaceCharStreamSource
- Overrides:
toString
in classObject
- Returns:
- the output as a string.
-
setNewLine
Sets the string to be used to represent a newline in the output.The default is to use the same new line string as is used in the source document, which is determined via the
Source.getNewLine()
method. If the source document does not contain any new lines, a "best guess" is made by either taking the new line string of a previously parsed document, or using the value from the staticConfig.NewLine
property.Specifying a
null
argument resets the property to its default value, which is to use the same new line string as is used in the source document.- Parameters:
newLine
- the string to be used to represent a newline in the output, may benull
.- Returns:
- this
SourceFormatter
instance, allowing multiple property setting methods to be chained in a single statement. - See Also:
-
getNewLine
Returns the string to be used to represent a newline in the output.See the
setNewLine(String)
method for a full description of this property.- Returns:
- the string to be used to represent a newline in the output.
-