org.netbeans.api.extexecution.base.input

Class InputProcessors

java.lang.Object

org.netbeans.api.extexecution.base.input.InputProcessors

public final class InputProcessors
extends Object

Factory methods for InputProcessor classes.

Method Summary

Modifier and Type	Method and Description
static InputProcessor	ansiStripping(InputProcessor delegate) Returns the processor that strips any ANSI escape sequences and passes the result to the delegate.
static InputProcessor	bridge(LineProcessor lineProcessor) Returns the processor converting characters to the whole lines passing them to the given line processor.
static InputProcessor	copying(Writer writer) Returns the processor that writes every character passed for processing to the given writer.
static InputProcessor	printing(PrintWriter out) Returns the processor printing all characters passed for processing to the given writer.
static InputProcessor	proxy(InputProcessor... processors) Returns the processor acting as a proxy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

bridge

@NonNull
public static InputProcessor bridge(@NonNull
                                             LineProcessor lineProcessor)

Returns the processor converting characters to the whole lines passing them to the given line processor.

Any reset or close is delegated to the corresponding method of line processor.

Returned processor is not thread safe.

Parameters:

lineProcessor - processor consuming parsed lines

Returns:

the processor converting characters to the whole lines

proxy

@NonNull
public static InputProcessor proxy(@NonNull
                                            InputProcessor... processors)

Returns the processor acting as a proxy.

Any action taken on this processor is distributed to all processors passed as arguments in the same order as they were passed to this method.

Returned processor is not thread safe.

Parameters:

processors - processor to which the actions will be distributed

Returns:

the processor acting as a proxy

copying

@NonNull
public static InputProcessor copying(@NonNull
                                              Writer writer)

Returns the processor that writes every character passed for processing to the given writer.

Reset action on the returned processor is noop. Processor closes the writer on InputProcessor.close().

Returned processor is not thread safe.

Parameters:

writer - processed characters will be written to this writer

Returns:

the processor that writes every character passed for processing to the given writer

printing

@NonNull
public static InputProcessor printing(@NonNull
                                               PrintWriter out)

Returns the processor printing all characters passed for processing to the given writer.

Reset action on the returned processor is noop. Processor closes the writer on InputProcessor.close().

Returned processor is not thread safe.

Parameters:

out - where to print received characters

Returns:

the processor printing all characters passed for processing to the given writer

ansiStripping

@NonNull
public static InputProcessor ansiStripping(@NonNull
                                                    InputProcessor delegate)

Returns the processor that strips any ANSI escape sequences and passes the result to the delegate.

Reset and close methods on the returned processor invokes the corresponding actions on delegate.

Returned processor is not thread safe.

Parameters:

delegate - processor that will receive characters without control sequences

Returns:

the processor that strips any ANSI escape sequences and passes the result to the delegate