Env (Command Line Parsing API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.sendopts/2 2.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.spi.sendopts
Class Env

java.lang.Object
  org.netbeans.spi.sendopts.Env

public final class Env
extends Object
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

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.

Methods inherited from class java.lang.Object

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

Method Summary
`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.

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