org.netbeans.api.io

Class IOProvider

java.lang.Object

org.netbeans.api.io.IOProvider

public abstract class IOProvider
extends Object

A factory for IO tabs shown in the output window. To create a new tab to write to, call e.g. IOProvider.getDefault().getIO("MyTab", false) (pass true if there may be an existing tab with the same name and you want to write to a new tab).

Methods of this class can be called in any thread.

Method Summary

Modifier and Type	Method and Description
static IOProvider	get(String id) Gets IOProvider of selected name or delegates to getDefault() if none was found.
static IOProvider	getDefault() Get the default I/O provider.
abstract String	getId() Gets identifier of this provider.
abstract InputOutput	getIO(String name, boolean newIO) Get a named instance of InputOutput, which represents an output tab in the output window.
abstract InputOutput	getIO(String name, boolean newIO, Lookup lookup) Get a named instance of InputOutput, which represents an output tab in the output window.

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

@NonNull
public static IOProvider getDefault()

Get the default I/O provider.

Normally this is taken from Lookup.getDefault() but if there is no instance in lookup, a fallback instance is created which just uses the standard system I/O streams. This is useful for unit tests and perhaps for standalone usage of various libraries.

Returns:

The default instance (never null).

get

@NonNull
public static IOProvider get(@NonNull
                                      String id)

Gets IOProvider of selected name or delegates to getDefault() if none was found.

Parameters:

id - ID of provider.

Returns:

The instance corresponding to provided name or default instance if not found.

getId

@NonNull
public abstract String getId()

Gets identifier of this provider.

Returns:

Name of this provider.

getIO

@NonNull
public abstract InputOutput getIO(@NonNull
                                           String name,
                                           boolean newIO)

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

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:

InputOutput

getIO

@NonNull
public abstract InputOutput getIO(@NonNull
                                           String name,
                                           boolean newIO,
                                           @NonNull
                                           Lookup lookup)

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

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:

InputOutput