org.netbeans.api.extexecution.base

Class BaseExecutionDescriptor

java.lang.Object

org.netbeans.api.extexecution.base.BaseExecutionDescriptor

public final class BaseExecutionDescriptor
extends Object

Descriptor for the execution service. Describes the runtime attributes of the BaseExecutionService.

Thread safety of this class depends on type of objects passed to its configuration methods. If these objects are immutable, resulting descriptor is immutable as well. It these objects are thread safe, resulting descriptor is thread safe as well.

See Also:

BaseExecutionService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseExecutionDescriptor.InputProcessorFactory Factory creating the input processor.
static interface	BaseExecutionDescriptor.ReaderFactory Factory creating the reader.

Constructor Summary

Constructors

Constructor and Description
BaseExecutionDescriptor() Creates the new descriptor.

Method Summary

Modifier and Type	Method and Description
BaseExecutionDescriptor	charset(Charset charset) Returns a descriptor with configured charset.
BaseExecutionDescriptor	errProcessorFactory(BaseExecutionDescriptor.InputProcessorFactory errProcessorFactory) Returns a descriptor with configured factory for standard error output processor.
BaseExecutionDescriptor	inReaderFactory(BaseExecutionDescriptor.ReaderFactory inReaderFactory) Returns a descriptor with configured factory for standard input reader.
BaseExecutionDescriptor	outProcessorFactory(BaseExecutionDescriptor.InputProcessorFactory outProcessorFactory) Returns a descriptor with configured factory for standard output processor.
BaseExecutionDescriptor	postExecution(ParametrizedRunnable<Integer> postExecution) Returns a descriptor with configured post execution runnable.
BaseExecutionDescriptor	preExecution(Runnable preExecution) Returns a descriptor with configured pre execution runnable.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseExecutionDescriptor

public BaseExecutionDescriptor()

Creates the new descriptor. All properties are initialized to null.

Method Detail

charset

@NonNull
 @CheckReturnValue
public BaseExecutionDescriptor charset(@NullAllowed
                                                                   Charset charset)

Returns a descriptor with configured charset. If configured value is not null the BaseExecutionService will use the given charset to decode the process streams. When null the platform default will be used.

Note that in the most common scenario of execution of OS native process you shouldn't need to set the charset. The platform default (which is the default used) is just the right choice.

The default (not configured) value is null.

All other properties of the returned descriptor are inherited from this.

Parameters:

charset - charset, null allowed

Returns:

this descriptor with configured charset

preExecution

@NonNull
 @CheckReturnValue
public BaseExecutionDescriptor preExecution(@NullAllowed
                                                                        Runnable preExecution)

Returns a descriptor with configured pre execution runnable. This runnable is executed before the external execution itself (when invoked by BaseExecutionService.run()).

The default (not configured) value is null.

All other properties of the returned descriptor are inherited from this.

Parameters:

preExecution - pre execution runnable, null allowed

Returns:

new descriptor with configured pre execution runnable

postExecution

@NonNull
 @CheckReturnValue
public BaseExecutionDescriptor postExecution(@NullAllowed
                                                                         ParametrizedRunnable<Integer> postExecution)

Returns a descriptor with configured post execution runnable. This runnable is executed after the external execution itself (when invoked by BaseExecutionService.run()).

The default (not configured) value is null.

All other properties of the returned descriptor are inherited from this.

Parameters:

postExecution - post execution runnable, null allowed

Returns:

new descriptor with configured post execution runnable

outProcessorFactory

@NonNull
 @CheckReturnValue
public BaseExecutionDescriptor outProcessorFactory(@NullAllowed
                                                                               BaseExecutionDescriptor.InputProcessorFactory outProcessorFactory)

Returns a descriptor with configured factory for standard output processor. The factory is used by BaseExecutionService to create processor for standard output.

The default (not configured) value is null.

All other properties of the returned descriptor are inherited from this.

Parameters:

outProcessorFactory - factory for standard output processor, null allowed

Returns:

new descriptor with configured factory for additional processor to use for standard output

errProcessorFactory

@NonNull
 @CheckReturnValue
public BaseExecutionDescriptor errProcessorFactory(@NullAllowed
                                                                               BaseExecutionDescriptor.InputProcessorFactory errProcessorFactory)

Returns a descriptor with configured factory for standard error output processor. The factory is used by BaseExecutionService to create processor for standard error output.

The default (not configured) value is null.

All other properties of the returned descriptor are inherited from this.

Parameters:

errProcessorFactory - factory for standard error output processor, null allowed

Returns:

new descriptor with configured factory for additional processor to use for standard error output

inReaderFactory

@NonNull
 @CheckReturnValue
public BaseExecutionDescriptor inReaderFactory(@NullAllowed
                                                                           BaseExecutionDescriptor.ReaderFactory inReaderFactory)

Returns a descriptor with configured factory for standard input reader. The factory is used by BaseExecutionService to create a reader providing input to the process.

The default (not configured) value is null.

All other properties of the returned descriptor are inherited from this.

Parameters:

inReaderFactory - factory for standard input reader, null allowed

Returns:

new descriptor with configured factory for reader to use for standard input