dev.nokee.core.exec

Interface CommandLineToolLogContent

public interface CommandLineToolLogContent

A representation of the log content from a command line tool execution. The log content can be manipulated according to the consumer's need.

Since:

0.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CommandLineToolLogContent.LineDetails

Method Summary

Modifier and Type	Method and Description
CommandLineToolLogContent	drop(int n) Drops the first n lines.
static CommandLineToolLogContent	empty() Creates an empty log content.
String	getAsString() Returns the log content as a string.
List<String>	getLines() Returns this content separated into lines.
static CommandLineToolLogContent	of(String content) Creates an log content of the specified string.
<T> T	parse(CommandLineToolOutputParser<T> parser) Returns a structured representation of the log content parsed by the specified parser.
CommandLineToolLogContent	visitEachLine(Consumer<CommandLineToolLogContent.LineDetails> visitor) Visit each lines.
CommandLineToolLogContent	withAnsiControlCharactersInterpreted() Interprets a the ANSI control characters to produce plain text.
CommandLineToolLogContent	withNormalizedEndOfLine() Returns this content formatted using a new line char to separate lines.

Method Detail

of

static CommandLineToolLogContent of(String content)

Creates an log content of the specified string.

Parameters:

content - the raw content of the log content

Returns:

an CommandLineToolLogContent instance representing the specified content, never null.

Since:

0.5

empty

static CommandLineToolLogContent empty()

Creates an empty log content.

Returns:

an empty CommandLineToolLogContent instance, never null.

Since:

0.5

parse

<T> T parse(CommandLineToolOutputParser<T> parser)

Returns a structured representation of the log content parsed by the specified parser. The parser will received the log content and return any object representing what needs to be parsed.

Type Parameters:

T - the structured representation type returned by the parser

Parameters:

parser - the parser to use

Returns:

a structured representation of the log content.

getAsString

String getAsString()

Returns the log content as a string.

Returns:

a String representation of the log content.

withNormalizedEndOfLine

CommandLineToolLogContent withNormalizedEndOfLine()

Returns this content formatted using a new line char to separate lines.

Returns:

a new CommandLineToolLogContent instance using a new line char to separate lines, never null.

Since:

0.5

drop

CommandLineToolLogContent drop(int n)

Drops the first n lines.

Parameters:

n - the number of lines to drop from the log content

Returns:

a new CommandLineToolLogContent instance without the first n lines, never null.

Since:

0.5

withAnsiControlCharactersInterpreted

CommandLineToolLogContent withAnsiControlCharactersInterpreted()

Interprets a the ANSI control characters to produce plain text.

Returns:

a new CommandLineToolLogContent instance with all ANSI control characters interpreted, never null.

Since:

0.5

getLines

List<String> getLines()

Returns this content separated into lines. The line does not include the line separator.

Returns:

the lines of the content, never null.

Since:

0.5

visitEachLine

CommandLineToolLogContent visitEachLine(Consumer<CommandLineToolLogContent.LineDetails> visitor)

Visit each lines.

Returns:

a new CommandLineToolLogContent instance of the result following the visit, never null.

Since:

0.5