com.asakusafw.runtime.io.text.driver

Interface FieldOutput

All Known Implementing Classes:

BasicFieldOutput

public interface FieldOutput

An output target of FieldAdapter.

Since:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FieldOutput.Option Represents an option of FieldOutput.

Method Summary

Modifier and Type	Method and Description
default StringBuilder	acquireBuffer() Acquires the internal buffer.
FieldOutput	addOption(FieldOutput.Option option) Adds an option of this output.
default FieldOutput	addOptions(FieldOutput.Option... options) Adds options of this output.
CharSequence	get() Returns the output contents.
Collection<? extends FieldOutput.Option>	getOptions() Returns the options of this output.
default FieldOutput	put(CharSequence contents) Adds a content into this output.
FieldOutput	put(CharSequence contents, int start, int end) Adds a content into this output.
void	putNull() Sets this field as NULL.
default void	releaseBuffer(StringBuilder acquired) Releases the acquired buffer.

Method Detail

get

CharSequence get()

Returns the output contents.

Returns:

the output contents, or null if this output was set as null

getOptions

Collection<? extends FieldOutput.Option> getOptions()

Returns the options of this output.

Returns:

the options

putNull

void putNull()

Sets this field as NULL.

Throws:

IllegalStateException - if this field already has any other contents

put

FieldOutput put(CharSequence contents,
                int start,
                int end)

Adds a content into this output.

Parameters:

contents - the content

start - the beginning index (inclusive)

end - the ending index (exclusive)

Returns:

this

Throws:

IllegalStateException - if this field was already set as null

put

default FieldOutput put(CharSequence contents)

Adds a content into this output.

Parameters:

contents - the content

Returns:

this

Throws:

IllegalStateException - if this field was already set as null

addOption

FieldOutput addOption(FieldOutput.Option option)

Adds an option of this output.

Parameters:

option - the options

Returns:

this

addOptions

default FieldOutput addOptions(FieldOutput.Option... options)

Adds options of this output.

Parameters:

options - the options

Returns:

this

acquireBuffer

default StringBuilder acquireBuffer()

Acquires the internal buffer.

Returns:

the internal buffer, always empty

Throws:

IllegalStateException - if this field already has some content (optional)

releaseBuffer

default void releaseBuffer(StringBuilder acquired)

Releases the acquired buffer.

Parameters:

acquired - the buffer to release

Throws:

IllegalStateException - if the given buffer is not acquired from this output