public abstract class InputBuffer
extends Input

Non-blocking token stream buffer.

Constructor Summary

Constructors
Constructor Description

InputBuffer()

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()`
`abstract InputBuffer`	`clone()`	Returns an independently positioned view into the token stream, initialized with identical state to this `Input`.
`static InputBuffer`	`done()`	Returns an `InputBuffer` in the done state.
`static InputBuffer`	`done(Object id, Mark mark)`	Returns an `InputBuffer` in the done state, at the `mark` position of a token stream logically identified by `id`.
`static InputBuffer`	`done(Object id, Mark mark, InputSettings settings)`	Returns an `InputBuffer` in the done state, at the `mark` position of a token stream logically identified by `id`, with the given `settings`.
`static InputBuffer`	`done(InputSettings settings)`	Returns an `InputBuffer` in the done state, with the given `settings`.
`static InputBuffer`	`empty()`	Returns an `InputBuffer` in the empty state.
`static InputBuffer`	`empty(Object id, Mark mark)`	Returns an `InputBuffer` in the empty state, at the `mark` position of a token stream logically identified by `id`.
`static InputBuffer`	`empty(Object id, Mark mark, InputSettings settings)`	Returns an `InputBuffer` in the empty state, at the `mark` position of a token stream logically identified by `id`, with the given `settings`.
`static InputBuffer`	`empty(InputSettings settings)`	Returns an `InputBuffer` in the empty state, with the given `settings`.
`static InputBuffer`	`error(Throwable error)`	Returns an `InputBuffer` in the error state, with the given input `error`.
`static InputBuffer`	`error(Throwable error, Object id, Mark mark)`	Returns an `InputBuffer` in the error state, with the given input `error`, at the `mark` position of a token stream logically identified by `id`.
`static InputBuffer`	`error(Throwable error, Object id, Mark mark, InputSettings settings)`	Returns an `InputBuffer` in the error state, with the given input `error`, at the `mark` position of a token stream logically identified by `id`, with the given `settings`.
`static InputBuffer`	`error(Throwable error, InputSettings settings)`	Returns an `InputBuffer` in the error state, with the given input `error` and `settings`.
`InputBuffer`	`fork(Object condition)`	Returns an `Input` equivalent to this `Input`, but whose behavior may be altered by the given out-of-band `condition`.
`abstract int`	`get(int index)`
`abstract boolean`	`has(int index)`
`abstract InputBuffer`	`id(Object id)`	Returns an `Input` equivalent to this `Input`, but logically identified by the given–possibly `null`–`id`.
`abstract int`	`index()`
`abstract InputBuffer`	`index(int index)`
`abstract InputBuffer`	`isPart(boolean isPart)`	Returns a partial `Input` equivalent to this `Input`, if `isPart` is `true`; returns a final `Input` equivalent to this `Input` if `isPart` is `false`.
`abstract int`	`limit()`
`abstract InputBuffer`	`limit(int limit)`
`abstract InputBuffer`	`mark(Mark mark)`	Returns an `Input` equivalent to this `Input`, but logically positioned at the given `mark`.
`abstract int`	`remaining()`
`abstract InputBuffer`	`seek(Mark mark)`	Returns an `Input` equivalent to this `Input`, but repositioned to the given `mark`.
`abstract void`	`set(int index, int token)`
`abstract InputBuffer`	`settings(InputSettings settings)`	Returns an `Input` equivalent to this `Input`, but with the given input `settings`.
`abstract InputBuffer`	`step()`	Returns an `Input` equivalent to this `Input`, but advanced to the next token.
`abstract InputBuffer`	`step(int offset)`

Methods inherited from class swim.codec.Input
column, head, id, isCont, isDone, isEmpty, isError, isPart, line, mark, offset, settings, trap

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

- Constructor Detail
  - InputBuffer
```
public InputBuffer()
```
- Method Detail
  - isPart
```
public abstract InputBuffer isPart(boolean isPart)
```
    Description copied from class: Input
    
    Returns a partial Input equivalent to this Input, if isPart is true; returns a final Input equivalent to this Input if isPart is false. The caller's reference to this Input should be replaced by the returned Input.
    
    Specified by:
    
    isPart in class Input
  - index
```
public abstract int index()
```
  - index
```
public abstract InputBuffer index(int index)
```
  - limit
```
public abstract int limit()
```
  - limit
```
public abstract InputBuffer 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)
```
  - step
```
public abstract InputBuffer step()
```
    Description copied from class: Input
    
    Returns an Input equivalent to this Input, but advanced to the next token. Returns an Input in the error state if this Input is not in the cont state. The caller's reference to this Input should be replaced by the returned Input.
    
    Specified by:
    
    step in class Input
  - step
```
public abstract InputBuffer step(int offset)
```
  - seek
```
public abstract InputBuffer seek(Mark mark)
```
    Description copied from class: Input
    
    Returns an Input equivalent to this Input, but repositioned to the given mark. Returns an Input in the error state if this Input does not support seeking, or if this Input is unable to reposition to the given mark. The caller's reference to this Input should be replaced by the returned Input.
    
    Specified by:
    
    seek in class Input
  - fork
```
public InputBuffer fork(Object condition)
```
    Description copied from class: Input
    
    Returns an Input equivalent to this Input, but whose behavior may be altered by the given out-of-band condition. The caller's reference to this Input should be replaced by the returned Input.
    
    Overrides:
    
    fork in class Input
  - id
```
public abstract InputBuffer id(Object id)
```
    Description copied from class: Input
    
    Returns an Input equivalent to this Input, but logically identified by the given–possibly null–id. The caller's reference to this Input should be replaced by the returned Input.
    
    Specified by:
    
    id in class Input
  - mark
```
public abstract InputBuffer mark(Mark mark)
```
    Description copied from class: Input
    
    Returns an Input equivalent to this Input, but logically positioned at the given mark. The physical position in the input stream is not modified. The caller's reference to this Input should be replaced by the returned Input.
    
    Specified by:
    
    mark in class Input
  - settings
```
public abstract InputBuffer settings(InputSettings settings)
```
    Description copied from class: Input
    
    Returns an Input equivalent to this Input, but with the given input settings. The caller's reference to this Input should be replaced by the returned Input.
    
    Specified by:
    
    settings in class Input
  - clone
```
public abstract InputBuffer clone()
```
    Description copied from class: Input
    
    Returns an independently positioned view into the token stream, initialized with identical state to this Input.
    
    Specified by:
    
    clone in class Input
  - empty
```
public static InputBuffer empty()
```
    Returns an InputBuffer in the empty state.
  - empty
```
public static InputBuffer empty(InputSettings settings)
```
    Returns an InputBuffer in the empty state, with the given settings.
  - empty
```
public static InputBuffer empty(Object id,
                                Mark mark)
```
    Returns an InputBuffer in the empty state, at the mark position of a token stream logically identified by id.
  - empty
```
public static InputBuffer empty(Object id,
                                Mark mark,
                                InputSettings settings)
```
    Returns an InputBuffer in the empty state, at the mark position of a token stream logically identified by id, with the given settings.
  - done
```
public static InputBuffer done()
```
    Returns an InputBuffer in the done state.
  - done
```
public static InputBuffer done(InputSettings settings)
```
    Returns an InputBuffer in the done state, with the given settings.
  - done
```
public static InputBuffer done(Object id,
                               Mark mark)
```
    Returns an InputBuffer in the done state, at the mark position of a token stream logically identified by id.
  - done
```
public static InputBuffer done(Object id,
                               Mark mark,
                               InputSettings settings)
```
    Returns an InputBuffer in the done state, at the mark position of a token stream logically identified by id, with the given settings.
  - error
```
public static InputBuffer error(Throwable error)
```
    Returns an InputBuffer in the error state, with the given input error.
  - error
```
public static InputBuffer error(Throwable error,
                                InputSettings settings)
```
    Returns an InputBuffer in the error state, with the given input error and settings.
  - error
```
public static InputBuffer error(Throwable error,
                                Object id,
                                Mark mark)
```
    Returns an InputBuffer in the error state, with the given input error, at the mark position of a token stream logically identified by id.
  - error
```
public static InputBuffer error(Throwable error,
                                Object id,
                                Mark mark,
                                InputSettings settings)
```
    Returns an InputBuffer in the error state, with the given input error, at the mark position of a token stream logically identified by id, with the given settings.

Class InputBuffer

Constructor Summary

Method Summary

Methods inherited from class swim.codec.Input

Methods inherited from class java.lang.Object

Constructor Detail

InputBuffer

Method Detail

isPart

index

index

limit

limit

capacity

remaining

array

arrayOffset

has

get

set

step

step

seek

fork

id

mark

settings

clone

empty

empty

empty

empty

done

done

done

done

error

error

error

error