org.netbeans.spi.io

Interface InputOutputProvider<IO,WRITER extends PrintWriter,POS,FOLD>

Type Parameters:

IO - Type of objects that will represent I/O instances (e.g. tabs in output window).

WRITER - Type of writers for standard and error streams.

POS - Type of object that describes position of a character in the output window. If the implementation does not support this type of information, use Void here.

FOLD - Type of object that describes a fold in output window. If the implementation does not support this type of information, use Void here.

public interface InputOutputProvider<IO,WRITER extends PrintWriter,POS,FOLD>

SPI for custom output window implementations.

Use ServiceProvider annotation for registration.

Note: Methods of this interface can be called in any thread by the infrastructure, so implementations should ensure proper synchronization.

Method Summary

Modifier and Type	Method and Description
void	closeIO(IO io) Close the I/O, its output pane and release resources.
void	endFold(IO io, WRITER writer, FOLD fold) Finish a fold specified by its start position.
POS	getCurrentPosition(IO io, WRITER writer) Get current position.
WRITER	getErr(IO io) Get error stream of the passed I/O.
String	getId() Get identifier of this provider.
Reader	getIn(IO io) Get input of the passed I/O.
IO	getIO(String name, boolean newIO, Lookup lookup) Get or create an object that encapsulates state of a single I/O instance (e.g.
String	getIODescription(IO io) Get description of an I/O instance.
Lookup	getIOLookup(IO io) Get lookup of an I/O instance, which can contain various extensions and additional info.
WRITER	getOut(IO io) Get output stream of the passed I/O.
boolean	isIOClosed(IO io) Check whether the I/O is closed.
void	print(IO io, WRITER writer, String text, Hyperlink link, OutputColor color, boolean printLineEnd) Print enhanced text.
void	resetIO(IO io) Reset the I/O.
void	scrollTo(IO io, WRITER writer, POS position) Scroll to a position.
void	setFoldExpanded(IO io, WRITER writer, FOLD fold, boolean expanded) Expand or collapse a fold.
void	setIODescription(IO io, String description) Set description of an I/O instance.
void	showIO(IO io, Set<ShowOperation> operations) Show output pane for the passed I/O instance.
FOLD	startFold(IO io, WRITER writer, boolean expanded) Start fold at the current position.

Method Detail

getId

@NonNull
String getId()

Get identifier of this provider.

Returns:

Name of this provider, never null.

getIO

@NonNull
IO getIO(@NonNull
                  String name,
                  boolean newIO,
                  @NonNull
                  Lookup lookup)

Get or create an object that encapsulates state of a single I/O instance (e.g. tab in output window).

Parameters:

name - Display name of the output pane.

newIO - True to always create new I/O, false to return already existing instance if available.

lookup - Lookup with additional information.

Returns:

A single I/O instance, a newly created or already existing.

See Also:

InputOutput

getIn

@NonNull
Reader getIn(@NonNull
                      IO io)

Get input of the passed I/O.

Parameters:

io - I/O instance.

Returns:

Reader Reader for the input entered in the output pane.

getOut

@NonNull
WRITER getOut(@NonNull
                       IO io)

Get output stream of the passed I/O.

Parameters:

io - I/O instance.

Returns:

PrintWriter for the output stream.

getErr

@NonNull
WRITER getErr(@NonNull
                       IO io)

Get error stream of the passed I/O.

Parameters:

io - The I/O instance.

Returns:

PrintWriter for the error stream.

print

void print(@NonNull
           IO io,
           @NonNull
           WRITER writer,
           @NullAllowed
           String text,
           @NullAllowed
           Hyperlink link,
           @NullAllowed
           OutputColor color,
           boolean printLineEnd)

Print enhanced text. It can represent a clickable hyperlink, and can be assigned some color.

If the implementation doesn't support this feature, this method should call something like writer.print(text); if (printLineEnd) {writer.println();}.

Parameters:

io - The I/O instance.

writer - The Stream to write into.

text - Text to print.

link - Link which should be represented by the text, can be null for standard text.

color - Color of the text, can be null for the default color of the stream.

printLineEnd - True if new-line should be appended after printing {code text}.

getIOLookup

@NonNull
Lookup getIOLookup(@NonNull
                            IO io)

Get lookup of an I/O instance, which can contain various extensions and additional info.

Parameters:

io - The I/O instance.

Returns:

The lookup, which can be empty, but never null.

resetIO

void resetIO(@NonNull
             IO io)

Reset the I/O. Clear previously written data and prepare it for new data.

If the implementation doesn't support this feature, this method should do nothing.

Parameters:

io - The I/O instance.

showIO

void showIO(@NonNull
            IO io,
            Set<ShowOperation> operations)

Show output pane for the passed I/O instance.

If the implementation doesn't support this feature, this method should do nothing.

Parameters:

io - The I/O instance.

operations - Operations that should be performed to show the output. If the set is empty, the output pane (e.g. tab) can be selected, but no GUI component should be shown or made visible if it is currently closed or hidden.

See Also:

ShowOperation

closeIO

void closeIO(@NonNull
             IO io)

Close the I/O, its output pane and release resources.

Parameters:

io - The I/O instance.

See Also:

InputOutputProvider.isIOClosed(java.lang.Object)

isIOClosed

boolean isIOClosed(@NonNull
                   IO io)

Check whether the I/O is closed.

Parameters:

io - The I/O instance.

Returns:

True if the I/O was closed, false otherwise.

See Also:

InputOutputProvider.closeIO(java.lang.Object)

getCurrentPosition

@CheckForNull
POS getCurrentPosition(@NonNull
                                     IO io,
                                     @NonNull
                                     WRITER writer)

Get current position.

Parameters:

io - The I/O instance.

writer - Output or error writer. If the streams are merged, the value can be ignored.

Returns:

The current position in the output pane. If this feature is not supported, return null.

scrollTo

void scrollTo(@NonNull
              IO io,
              @NonNull
              WRITER writer,
              @NonNull
              POS position)

Scroll to a position.

If this feature is not supported (InputOutputProvider.getCurrentPosition(Object, PrintWriter) returns null), this method should do nothing, it will be never called.

Parameters:

io - The I/O instance.

writer - Output or error writer. If the streams are merged, the value can be ignored.

position - The position to scroll to.

See Also:

InputOutputProvider.getCurrentPosition(java.lang.Object, java.io.PrintWriter)

startFold

@CheckForNull
FOLD startFold(@NonNull
                             IO io,
                             @NonNull
                             WRITER writer,
                             boolean expanded)

Start fold at the current position. If a fold is already open, start a new nested fold (but if a fold with the same start position already exists, no nested fold will be created, and the same start position will be returned).

Parameters:

io - The I/O instance.

writer - Output or error writer. If the streams are merged, the value can be ignored.

expanded - True if the new fold should be expanded by default, false if it should be collapsed.

Returns:

Object the fold. If the implementation doesn't support this feature, return null.

endFold

void endFold(@NonNull
             IO io,
             @NonNull
             WRITER writer,
             @NonNull
             FOLD fold)

Finish a fold specified by its start position. If some nested folds exist, they will be finished as well if needed.

If this feature is not supported (InputOutputProvider.startFold(Object, PrintWriter, boolean) returns null), this method should do nothing, it will be never called.

Parameters:

io - The I/O instance.

writer - Output or error writer. If the streams are merged, the value can be ignored.

fold - The fold to finish.

setFoldExpanded

void setFoldExpanded(@NonNull
                     IO io,
                     @NonNull
                     WRITER writer,
                     FOLD fold,
                     boolean expanded)

Expand or collapse a fold.

If this feature is not supported (InputOutputProvider.startFold(Object, PrintWriter, boolean) returns null), this method should do nothing, it will be never called.

Parameters:

io - The I/O instance.

writer - Output or error writer. If the streams are merged, the value can be ignored.

fold - The fold to finish.

expanded - True to expand the fold, false to collapse the fold.

getIODescription

@CheckForNull
String getIODescription(@NonNull
                                      IO io)

Get description of an I/O instance. It can be used e.g. as tooltip text for the output tab.

Parameters:

io - The I/O instance.

Returns:

The description, or null if not set.

setIODescription

void setIODescription(@NonNull
                      IO io,
                      @NullAllowed
                      String description)

Set description of an I/O instance.

If this feature is not supported, this method should do nothing.

Parameters:

io - The I/O instance.

description - The description, can be null.

See Also:

InputOutputProvider.getIODescription(java.lang.Object)