BufferedOutput

com.phasmidsoftware.gambit.attic.BufferedOutput
sealed trait BufferedOutput extends TypedOutput

Trait to define the behavior of a TypedOutput which has a buffer.

Attributes

Graph
Supertypes
trait TypedOutput
trait Output
trait AutoCloseable
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Inherited and Abstract types

type OutputType

The output type for this TypedOutput

The output type for this TypedOutput

Attributes

Inherited from:
TypedOutput

Value members

Abstract methods

def appendToBuffer(x: OutputType): Unit

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.

def concatenate(output: Output): Output

Method to return the current content of the buffer.

Method to return the current content of the buffer.

Attributes

Returns

an OutputType

def contentBrief: String
def flush: Output

Method to flush the buffer and return this.

Method to flush the buffer and return this.

Attributes

Returns

this Output.

def isBacked: Boolean

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.

def isEmpty: Boolean

Method to determine if the buffer is empty.

Method to determine if the buffer is empty.

Attributes

Returns

true if there is nothing in the buffer.

def isFlushed: Boolean

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

def needsToFlush: Boolean

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.

Concrete methods

def ++(other: Output): 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.

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.

Method to do a conditional flush of the buffer.

Method to do a conditional flush of the buffer.

Attributes

Returns

this Output.

def nonEmpty: Boolean

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.

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 methods

def ++(xs: Iterator[Output])(implicit separator: Output): Output

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
def ++(xs: Iterable[Output])(implicit separator: Output): Output

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
def +:(x: Any): Output

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
def :+(x: Any): 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

Inherited and Abstract methods

def asOutputType(x: Any): OutputType

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:
TypedOutput
def close(): Unit

Attributes

Inherited from:
AutoCloseable
def copy: Output

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
def indent(c: CharSequence): 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

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

Inherited from:
Output

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:
TypedOutput