java.lang.Object
- swim.codec.Output<T>
- - swim.codec.OutputBuffer<T>

public abstract class OutputBuffer<T>
extends Output<T>

Non-blocking token stream buffer.

Constructor Summary

Constructors
Constructor Description

OutputBuffer()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract byte[]`	`array()`
`abstract int`	`arrayOffset()`
`abstract int`	`capacity()`
`OutputBuffer<T>`	`clone()`	Returns an implementation-defined branch of the token stream.
`OutputBuffer<T>`	`debug(Object object)`	Writes the code points of the developer-readable `Debug` string of the given `object`.
`OutputBuffer<T>`	`display(Object object)`	Writes the code points of the human-readable `Display` string of the given `object`.
`static <T> OutputBuffer<T>`	`done()`	Returns an `OutputBuffer` in the done state, that binds a `null` result.
`static <T> OutputBuffer<T>`	`done(OutputSettings settings)`	Returns an `OutputBuffer` in the done state, with the given `settings`.
`static <T> OutputBuffer<T>`	`done(T value)`	Returns an `OutputBuffer` in the done state, that binds the given `value`.
`static <T> OutputBuffer<T>`	`done(T value, OutputSettings settings)`	Returns an `OutputBuffer` in the done state, that binds the given `value`, with the given `settings`.
`static <T> OutputBuffer<T>`	`error(Throwable error)`	Returns an `OutputBuffer` in the error state, with the given output `error`.
`static <T> OutputBuffer<T>`	`error(Throwable error, OutputSettings settings)`	Returns an `OutputBuffer` in the error state, with the given output `error` and `settings`.
`OutputBuffer<T>`	`flush()`	Writes any internally buffered state to the underlying output stream.
`OutputBuffer<T>`	`fork(Object condition)`	Returns an `Output` equivalent to this `Output`, but whose behavior may be altered by the given out-of-band `condition`.
`static <T> OutputBuffer<T>`	`full()`	Returns an `OutputBuffer` in the full state, that binds a `null` result.
`static <T> OutputBuffer<T>`	`full(OutputSettings settings)`	Returns an `OutputBuffer` in the full state, with the given `settings`.
`static <T> OutputBuffer<T>`	`full(T value)`	Returns an `OutputBuffer` in the full state, that binds the given `value`.
`static <T> OutputBuffer<T>`	`full(T value, OutputSettings settings)`	Returns an `OutputBuffer` in the full state, that binds the given `value`, with the given `settings`.
`abstract int`	`get(int index)`
`abstract boolean`	`has(int index)`
`abstract int`	`index()`
`abstract OutputBuffer<T>`	`index(int index)`
`abstract OutputBuffer<T>`	`isPart(boolean isPart)`	Returns a partial `Output` equivalent to this `Output`, if `isPart` is `true`; returns a final `Output` equivalent to this `Output` if `isPart` is `false`.
`abstract int`	`limit()`
`abstract OutputBuffer<T>`	`limit(int limit)`
`abstract OutputBuffer<T>`	`move(int fromIndex, int toIndex, int length)`
`abstract int`	`remaining()`
`abstract void`	`set(int index, int token)`
`abstract OutputBuffer<T>`	`settings(OutputSettings settings)`	Updates the `settings` associated with this `Output`.
`abstract OutputBuffer<T>`	`step(int offset)`
`abstract OutputBuffer<T>`	`write(int token)`	Writes a single `token` to the stream, if this `Output` is in the cont state.
`OutputBuffer<T>`	`write(String string)`	Writes the code points of the given `string`.
`abstract int`	`write(ReadableByteChannel channel)`
`OutputBuffer<T>`	`writeln()`	Writes the code points of the `settings`' `line separator`.
`OutputBuffer<T>`	`writeln(String string)`	Writes the code points of the given `string`, followed by the code points of the `settings`' `line separator`.

Methods inherited from class swim.codec.Output
bind, isCont, isDone, isError, isFull, isPart, settings, trap

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OutputBuffer
```
public OutputBuffer()
```
- Method Detail
  - isPart
```
public abstract OutputBuffer<T> isPart(boolean isPart)
```
    Description copied from class: Output
    
    Returns a partial Output equivalent to this Output, if isPart is true; returns a final Output equivalent to this Output if isPart is false. The caller's reference to this Output should be replaced by the returned Output.
    
    Specified by:
    
    isPart in class Output<T>
  - index
```
public abstract int index()
```
  - index
```
public abstract OutputBuffer<T> index(int index)
```
  - limit
```
public abstract int limit()
```
  - limit
```
public abstract OutputBuffer<T> limit(int limit)
```
  - capacity
```
public abstract int capacity()
```
  - remaining
```
public abstract int remaining()
```
  - array
```
public abstract byte[] array()
```
  - arrayOffset
```
public abstract int arrayOffset()
```
  - has
```
public abstract boolean has(int index)
```
  - get
```
public abstract int get(int index)
```
  - set
```
public abstract void set(int index,
                         int token)
```
  - write
```
public abstract int write(ReadableByteChannel channel)
                   throws IOException
```
    Throws:
    
    IOException
  - write
```
public abstract OutputBuffer<T> write(int token)
```
    Description copied from class: Output
    
    Writes a single token to the stream, if this Output is in the cont state. Returns an Output in the error state if this Output is not in the cont state. The caller's reference to this Output should be replaced by the returned Output.
    
    Specified by:
    
    write in class Output<T>
  - write
```
public OutputBuffer<T> write(String string)
```
    Description copied from class: Output
    
    Writes the code points of the given string. Assumes this is a Unicode Output with sufficient capacity. Returns an Output in the error state if this Output exits the cont state before the full string has been writtem. The caller's reference to this Output should be replaced by the returned Output.
    
    Overrides:
    
    write in class Output<T>
  - writeln
```
public OutputBuffer<T> writeln(String string)
```
    Description copied from class: Output
    
    Writes the code points of the given string, followed by the code points of the settings' line separator. Assumes this is a Unicode Output with sufficient capacity. Returns an Output in the error state if this Output exits the cont state before the full string and line separator has been written. The caller's reference to this Output should be replaced by the returned Output.
    
    Overrides:
    
    writeln in class Output<T>
  - writeln
```
public OutputBuffer<T> writeln()
```
    Description copied from class: Output
    
    Writes the code points of the settings' line separator. Assumes this is a Unicode Output with sufficient capacity. Returns an Output in the error state if this Output exits the cont state before the full line separator has been written. The caller's reference to this Output should be replaced by the returned Output.
    
    Overrides:
    
    writeln in class Output<T>
  - display
```
public OutputBuffer<T> display(Object object)
```
    Description copied from class: Output
    
    Writes the code points of the human-readable Display string of the given object. Assumes this is a Unicode Output with sufficient capacity. Returns an Output in the error state if this Output exits the contt state before the full display string has been written. The caller's reference to this Output should be replaced by the returned Output.
    
    Overrides:
    
    display in class Output<T>
  - debug
```
public OutputBuffer<T> debug(Object object)
```
    Description copied from class: Output
    
    Writes the code points of the developer-readable Debug string of the given object. Assumes this is a Unicode Output with sufficient capacity. Returns an Output in the error state if this Output exits the contt state before the full debug string has been written. The caller's reference to this Output should be replaced by the returned Output.
    
    Overrides:
    
    debug in class Output<T>
  - move
```
public abstract OutputBuffer<T> move(int fromIndex,
                                     int toIndex,
                                     int length)
```
  - step
```
public abstract OutputBuffer<T> step(int offset)
```
  - flush
```
public OutputBuffer<T> flush()
```
    Description copied from class: Output
    
    Writes any internally buffered state to the underlying output stream.
    
    Overrides:
    
    flush in class Output<T>
  - fork
```
public OutputBuffer<T> fork(Object condition)
```
    Description copied from class: Output
    
    Returns an Output equivalent to this Output, but whose behavior may be altered by the given out-of-band condition. The caller's reference to this Output should be replaced by the returned Output.
    
    Overrides:
    
    fork in class Output<T>
  - settings
```
public abstract OutputBuffer<T> settings(OutputSettings settings)
```
    Description copied from class: Output
    
    Updates the settings associated with this Output.
    
    Specified by:
    
    settings in class Output<T>
    
    Returns:
    
    this
  - clone
```
public OutputBuffer<T> clone()
```
    Description copied from class: Output
    
    Returns an implementation-defined branch of the token stream.
    
    Overrides:
    
    clone in class Output<T>
  - full
```
public static <T> OutputBuffer<T> full()
```
    Returns an OutputBuffer in the full state, that binds a null result.
  - full
```
public static <T> OutputBuffer<T> full(OutputSettings settings)
```
    Returns an OutputBuffer in the full state, with the given settings.
  - full
```
public static <T> OutputBuffer<T> full(T value)
```
    Returns an OutputBuffer in the full state, that binds the given value.
  - full
```
public static <T> OutputBuffer<T> full(T value,
                                       OutputSettings settings)
```
    Returns an OutputBuffer in the full state, that binds the given value, with the given settings.
  - done
```
public static <T> OutputBuffer<T> done()
```
    Returns an OutputBuffer in the done state, that binds a null result.
  - done
```
public static <T> OutputBuffer<T> done(OutputSettings settings)
```
    Returns an OutputBuffer in the done state, with the given settings.
  - done
```
public static <T> OutputBuffer<T> done(T value)
```
    Returns an OutputBuffer in the done state, that binds the given value.
  - done
```
public static <T> OutputBuffer<T> done(T value,
                                       OutputSettings settings)
```
    Returns an OutputBuffer in the done state, that binds the given value, with the given settings.
  - error
```
public static <T> OutputBuffer<T> error(Throwable error)
```
    Returns an OutputBuffer in the error state, with the given output error.
  - error
```
public static <T> OutputBuffer<T> error(Throwable error,
                                        OutputSettings settings)
```
    Returns an OutputBuffer in the error state, with the given output error and settings.

Class OutputBuffer<T>

Constructor Summary

Method Summary

Methods inherited from class swim.codec.Output

Methods inherited from class java.lang.Object

Constructor Detail

OutputBuffer

Method Detail

isPart

index

index

limit

limit

capacity

remaining

array

arrayOffset

has

get

set

write

write

write

writeln

writeln

display

debug

move

step

flush

fork

settings

clone

full

full

full

full

done

done

done

done

error

error