org.netbeans.api.io

Class InputOutput

java.lang.Object

org.netbeans.api.io.InputOutput

All Implemented Interfaces:

Lookup.Provider

public abstract class InputOutput
extends Object
implements Lookup.Provider

An I/O connection to one tab on the Output Window. To acquire an instance to write to, call, e.g., IOProvider.getDefault().getInputOutput("someName", false). To get actual streams to write to, call getOut() or getErr() on the returned instance.

Generally it is preferable not to hold a reference to an instance of InputOutput, but rather to fetch it by name from IOProvider as needed.

Methods of this class can be called in any thread.

See Also:

OutputWriter

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this tab.
static InputOutput	get(String name, boolean newIO) Get a named instance of InputOutput from the default IOProvider, which represents an output tab in the output window.
static InputOutput	get(String name, boolean newIO, Lookup lookup) Get a named instance of InputOutput from the default IOProvider, which represents an output tab in the output window.
abstract String	getDescription() Get description of this I/O instance.
abstract OutputWriter	getErr() Get an output writer to write to the tab in error mode.
abstract Reader	getIn() Get a reader to read from the tab.
abstract Lookup	getLookup() Get lookup which may contain extensions provided by implementation of output window.
abstract OutputWriter	getOut() Acquire an output writer to write to the tab.
abstract boolean	isClosed() Test whether this tab has been closed, either by a call to InputOutput.close() or by the user closing the tab in the UI.
abstract void	reset() Clear the output pane.
abstract void	setDescription(String description) Set description of this I/O instance.
void	show() Show this I/O if possible (e.g.
abstract void	show(Set<ShowOperation> operations) Show this I/O if possible (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

get

@NonNull
public static InputOutput get(@NonNull
                                       String name,
                                       boolean newIO)

Get a named instance of InputOutput from the default IOProvider, which represents an output tab in the output window. Streams for reading/writing can be accessed via getters on the returned instance.

This is a shorthand for IOProvider.getDefault().getIO(...).

Parameters:

name - A localised display name for the tab.

newIO - If true, a new InputOutput is returned, else an existing InputOutput of the same name may be returned.

Returns:

An InputOutput instance for accessing the new tab.

See Also:

IOProvider

get

@NonNull
public static InputOutput get(@NonNull
                                       String name,
                                       boolean newIO,
                                       @NonNull
                                       Lookup lookup)

Get a named instance of InputOutput from the default IOProvider, which represents an output tab in the output window. Streams for reading/writing can be accessed via getters on the returned instance.

This is a shorthand for IOProvider.getDefault().getIO(...).

Parameters:

name - A localised display name for the tab.

newIO - If true, a new InputOutput is returned, else an existing InputOutput of the same name may be returned.

lookup - Lookup which may contain additional information for various implementations of output window.

Returns:

An InputOutput instance for accessing the new tab.

See Also:

IOProvider

getIn

@NonNull
public abstract Reader getIn()

Get a reader to read from the tab.

Returns:

The reader.

getOut

@NonNull
public abstract OutputWriter getOut()

Acquire an output writer to write to the tab.

Returns:

The writer.

getErr

@NonNull
public abstract OutputWriter getErr()

Get an output writer to write to the tab in error mode. This might show up in a different color than the regular output, e.g., or appear in a separate pane.

Returns:

The writer.

reset

public abstract void reset()

Clear the output pane.

getLookup

@NonNull
public abstract Lookup getLookup()

Get lookup which may contain extensions provided by implementation of output window.

Specified by:

getLookup in interface Lookup.Provider

Returns:

The lookup.

close

public abstract void close()

Closes this tab. The effect of calling any method on an instance of InputOutput after calling close() on it is undefined.

isClosed

public abstract boolean isClosed()

Test whether this tab has been closed, either by a call to InputOutput.close() or by the user closing the tab in the UI.

Returns:

Value true if it is closed.

getDescription

@CheckForNull
public abstract String getDescription()

Get description of this I/O instance.

Returns:

The description, or null if not set.

setDescription

public abstract void setDescription(@NullAllowed
                                    String description)

Set description of this I/O instance. It can be used e.g. as tooltip for output tab in the GUI.

Parameters:

description - The description, can be null.

show

public final void show()

Show this I/O if possible (e.g. in tabbed pane).

Calling this method is the same as calling:

 show(EnumSet.of(ShowOperation.OPEN, ShowOperation.MAKE_VISIBLE));
 

See Also:

InputOutput.show(java.util.Set)

show

public abstract void show(@NullAllowed
                          Set<ShowOperation> operations)

Show this I/O if possible (e.g. in tabbed pane).

Parameters:

operations - Set of operations that should be invoked to show the output. If the set is empty or null, pane for this I/O will be only selected, but its component will not be opened or made visible. So it will stay closed or hidden if it is not opened or not visible.

See Also:

ShowOperation