BufferedCharSequenceOutput
Abstract class to combine the behaviors of CharacterOutput, BufferedOutput and BackedOutput.
Type parameters
- A
-
the underlying (appendable) type.
Value parameters
- appendable
-
the persistent store of characters.
- indentation
-
the indentation to be used after a newline. NOTE: this is a var because sometimes when we concatenate Outputs, we have to update this value.
- sb
-
the StringBuilder that we use as temporary storage of characters.
Attributes
- Graph
-
- Supertypes
-
trait BackedOutput[A]trait BufferedOutputtrait CharacterOutputtrait TypedOutputtrait Outputtrait AutoCloseableclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class UnbackedOutputclass WriterOutput
Members list
Type members
Inherited types
The output type for this TypedOutput
Value members
Concrete methods
Method to append input to the buffer.
Method to append input to the buffer.
Value parameters
- x
-
the input to be appended.
Attributes
Method to clear the contents of the buffer and return its value.
Method to clear the contents of the buffer and return its value.
Attributes
- Returns
-
the OutputType that was the contents of the buffer.
Method to return the current content of the buffer.
Method to return the current content of the buffer.
Attributes
- Returns
-
an OutputType
Flush the buffer (sb) to the output.
Flush the buffer (sb) to the output.
Attributes
- Returns
-
an Output with an empty buffer.
This method inserts a break into the output. If the output is based on character sequences, then this method will cause a newline character to be inserted.
This method inserts a break into the output. If the output is based on character sequences, then this method will cause a newline character to be inserted.
Attributes
- Returns
-
this
This method is essentially non-functional in the JVM. It seemed like a good idea at the time!
This method is essentially non-functional in the JVM. It seemed like a good idea at the time!
Attributes
Method to determine if any data has been flushed to the backing sink.
Method to determine if any data has been flushed to the backing sink.
Attributes
Method to determine if the buffer needs to be flushed, for example it's getting too big.
Method to determine if the buffer needs to be flushed, for example it's getting too big.
Attributes
- Returns
-
true if it would be a good idea to flush the buffer.
This method copies the given content x to the backing object.
This method copies the given content x to the backing object.
Value parameters
- x
-
the content to be persisted.
Attributes
Inherited methods
Concatenate each element of the iterator xs to this in turn.
Concatenate each element of the iterator xs to this in turn.
Value parameters
- separator
-
an implicit separator
- xs
-
the iterator of Outputs.
Attributes
- Returns
-
this Output.
- Inherited from:
- TypedOutput
Concatenate each element of the iterable xs to this in turn.
Concatenate each element of the iterable xs to this in turn.
Value parameters
- separator
-
an implicit separator
- xs
-
an iterable of Outputs.
Attributes
- Returns
-
this Output.
- Inherited from:
- Output
Concatenate this Output (first) and x (second).
Concatenate this Output (first) and x (second).
Value parameters
- other
-
the other Output object.
Attributes
- Returns
-
this Output.
- Inherited from:
- BufferedOutput
Append this to the Output formed by x. NOTE: that this assumes that Output.apply is defined for String.
Append this to the Output formed by x. NOTE: that this assumes that Output.apply is defined for String.
Value parameters
- x
-
an Any
Attributes
- Returns
-
an Output, not necessarily this.
- Inherited from:
- Output
Append x to this Output.
Append x to this Output.
Value parameters
- x
-
an object of type Any
Attributes
- Returns
-
this Output.
- Inherited from:
- TypedOutput
Method to append an x of type OutputType to this Output.
Method to append an x of type OutputType to this Output.
Value parameters
- x
-
the input.
Attributes
- Returns
-
this Output.
- Inherited from:
- BufferedOutput
Attributes
- Inherited from:
- CharacterOutput
A converter from type Any to OutputType.
A converter from type Any to OutputType.
Value parameters
- x
-
the input.
Attributes
- Returns
-
the input, expressed an an OutputType.
- Inherited from:
- CharacterOutput
Method to do a conditional flush of the buffer.
Method to do a conditional flush of the buffer.
Attributes
- Returns
-
this Output.
- Inherited from:
- BufferedOutput
Method to determine if the buffer is non-empty.
Method to determine if the buffer is non-empty.
Attributes
- Returns
-
true if the buffer is non-empty.
- Inherited from:
- BufferedOutput
Method to return an Output built from the OutputType x.
Method to return an Output built from the OutputType x.
Value parameters
- x
-
the input of type OutputType.
Attributes
- Returns
-
a new instance of Output.
- Inherited from:
- BufferedOutput
A "zero" element for this TypedOutput. If OutputType is CharSequence, then we will return an empty String.
A "zero" element for this TypedOutput. If OutputType is CharSequence, then we will return an empty String.
Attributes
- Returns
-
a suitable empty OutputType.
- Inherited from:
- CharacterOutput
Inherited and Abstract methods
Method to create a copy of this Output. Content (whether flushed or not) will never be copied, but the other parameters of this Output may or may not be copied, depending on the actual implementation.
Method to create a copy of this Output. Content (whether flushed or not) will never be copied, but the other parameters of this Output may or may not be copied, depending on the actual implementation.
Attributes
- Returns
-
a new Output which is, essentially, similar to this but without any content.
- Inherited from:
- Output
Indent this Output so that the next insertBreak will use the updated indentation.
Indent this Output so that the next insertBreak will use the updated indentation.
Value parameters
- c
-
the indentation to be added.
Attributes
- Returns
-
a new Output with the appropriate indentation.
- Inherited from:
- Output
Method to return whether or not this Output is backed by real output type.
Method to return whether or not this Output is backed by real output type.
Attributes
- Returns
-
true if this Output is backed.
- Inherited from:
- BufferedOutput