Top Fields Methods
org.apache.sshd.common.util.io.output

public Interface LineLevelAppender

extends LineDataConsumer, Closeable
Imports
java.io.Closeable, .IOException, java.util.Objects, java.util.function.BooleanSupplier, org.apache.sshd.common.util.io.LineDataConsumer
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
public static final LineLevelAppender
EMPTY

public static final int
TYPICAL_LINE_LENGTH

A typical line length used in many textual standards

Inherited from org.apache.sshd.common.util.io.LineDataConsumer:
FAILIGNORE

Method Summary

Modifier and TypeMethod and Description
public default void
consume(CharSequence lineData)

Implements org.apache.sshd.common.util.io.LineDataConsumer.consume.

public boolean

Returns:

true if OK to accumulate data in work buffer
isWriteEnabled()

public static LineLevelAppender
wrap(Appendable appendable)

public static LineLevelAppender
wrap(Appendable appendable, BooleanSupplier writeEnabled)

public void
writeLineData(CharSequence
The "pure" line data - excluding any CR/LF(s).
lineData)

Called by the implementation once end-of-line is detected.

Inherited from java.io.Closeable:
close

Field Detail

EMPTYback to summary
public static final LineLevelAppender EMPTY
TYPICAL_LINE_LENGTHback to summary
public static final int TYPICAL_LINE_LENGTH

A typical line length used in many textual standards

Method Detail

consumeback to summary
public default void consume(CharSequence lineData) throws IOException

Implements org.apache.sshd.common.util.io.LineDataConsumer.consume.

Annotations
@Override
isWriteEnabledback to summary
public boolean isWriteEnabled()
Returns:boolean

true if OK to accumulate data in work buffer

wrapback to summary
public static LineLevelAppender wrap(Appendable appendable)
wrapback to summary
public static LineLevelAppender wrap(Appendable appendable, BooleanSupplier writeEnabled)
writeLineDataback to summary
public void writeLineData(CharSequence lineData) throws IOException

Called by the implementation once end-of-line is detected.

Parameters
lineData:CharSequence

The "pure" line data - excluding any CR/LF(s).

Exceptions
IOException:
If failed to write the data