org.netbeans.spi.sendopts

Class Env

java.lang.Object

org.netbeans.spi.sendopts.Env

public final class Env
extends Object

Represents the environment an OptionProcessor operates in. Streams can be used to read and write data provided by the user. It is also possible to obtain current user directory. In future this class may be extended with additional new getters that will describe the operating environment in greater detail.

Method Summary

Modifier and Type	Method and Description
File	getCurrentDirectory() The directory relative file operations shall be relative to.
PrintStream	getErrorStream() Get an output stream to which error messages may be sent.
InputStream	getInputStream() Get an input stream that may supply additional data.
PrintStream	getOutputStream() Get an output stream to which data may be sent.
void	usage() Prints the help usage for current set of options.
void	usage(OutputStream os) Prints the help usage for current set of options.

Methods inherited from class java.lang.Object

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

Method Detail

getOutputStream

public PrintStream getOutputStream()

Get an output stream to which data may be sent.

Returns:

stream to write to

getErrorStream

public PrintStream getErrorStream()

Get an output stream to which error messages may be sent.

Returns:

stream to write to

getCurrentDirectory

public File getCurrentDirectory()

The directory relative file operations shall be relative to. Can be specified while starting the parse of CommandLine.

Returns:

file representing current directory

getInputStream

public InputStream getInputStream()

Get an input stream that may supply additional data.

Returns:

stream to read from

usage

public void usage()

Prints the help usage for current set of options. Same as usage(getOutputStream()).

Since:

2.21

usage

public void usage(OutputStream os)

Prints the help usage for current set of options. This is a handy method if one wants to define a help option. In such case:

 public class MyOptions implements ArgsProcessor {
    @Arg(longName="help")
   public boolean help;
 
    @Override
   public void process(Env env) {
     if (help) env.usage(env.getErrorStream());
   }
 }
 

This method finds associated CommandLine and calls its usage method to print the help text to getOutputStream().

Parameters:

os - output stream to write the output to

Since:

2.37