public class OutputStreamOption extends StringOption
OutputStream
or Writer
.
The option takes one parameter and recognize that as a File
,
unless the parameter is '-', which is treated as System.out
.
For example, users can write "-log build.log" and
you can open this file as an OutputStream
,
or they can write "-log -" to send it to console.
If the option is unspecified, this will create OutputStream
that just discard the input.
This class can be extended to set the default output to change the interpretation of the unspecified state and "-".
CmdLineOption.Parameters
value
Constructor and Description |
---|
OutputStreamOption(java.lang.String optionName) |
OutputStreamOption(java.lang.String optionName,
java.lang.String defaultValue) |
Modifier and Type | Method and Description |
---|---|
protected java.io.OutputStream |
createConsoleStream()
Called when the option is '-' to create the
OutputStream . |
protected java.io.OutputStream |
createNullStream()
Called when the option is not specified to create the default
OutputStream |
java.io.OutputStream |
createOutputStream()
Opens the specified file for writing.
|
java.io.Writer |
createWriter()
Opens the specified file for writing.
|
accepts, parseArguments
public OutputStreamOption(java.lang.String optionName)
public OutputStreamOption(java.lang.String optionName, java.lang.String defaultValue)
public java.io.OutputStream createOutputStream() throws java.io.IOException
java.io.IOException
protected java.io.OutputStream createNullStream() throws java.io.IOException
OutputStream
java.io.IOException
protected java.io.OutputStream createConsoleStream() throws java.io.IOException
OutputStream
.java.io.IOException
public java.io.Writer createWriter() throws java.io.IOException
java.io.IOException
Copyright © 2003-2013 Kohsuke Kawaguchi. All Rights Reserved.