|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.cli.CommandLineOptions
public class CommandLineOptions
Options parses the commandline arguments
Field Summary | |
---|---|
static int |
AREATREE_INPUT
input: Area Tree XML file |
static int |
FO_INPUT
input: fo file |
static int |
IF_INPUT
input: Intermediate Format XML file |
static int |
IMAGE_INPUT
input: Image file |
static int |
NOT_SET
(input) not set |
static int |
RENDER_NONE
Used to indicate that only the result of the XSL transformation should be output |
static int |
XSLT_INPUT
input: xml+xsl file |
Constructor Summary | |
---|---|
CommandLineOptions()
Construct a command line option object. |
Method Summary | |
---|---|
java.io.File |
getFOFile()
Returns the XSL-FO file if set. |
protected FOUserAgent |
getFOUserAgent()
Get the FOUserAgent for this Command-Line run |
java.io.File |
getInputFile()
Returns the input file. |
InputHandler |
getInputHandler()
|
org.apache.commons.logging.Log |
getLogger()
Get the logger. |
java.io.File |
getOutputFile()
Returns the output file |
protected java.lang.String |
getOutputFormat()
|
java.io.File |
getUserConfigFile()
Returns the user configuration file to be used. |
java.io.File |
getXMLFile()
Returns the input XML file if set. |
java.io.File |
getXSLFile()
Returns the stylesheet to be used for transformation to XSL-FO. |
java.lang.Boolean |
isCoarseAreaXml()
Indicates whether the XML renderer should generate coarse area XML |
boolean |
isInputFromStdIn()
Indicates whether input comes from standard input (stdin). |
boolean |
isOutputToStdOut()
Indicates whether output is sent to standard output (stdout). |
boolean |
parse(java.lang.String[] args)
Parses the command line arguments. |
static void |
printUsage(java.io.PrintStream out)
Shows the command line syntax including a summary of all available options and some examples. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int RENDER_NONE
public static final int NOT_SET
public static final int FO_INPUT
public static final int XSLT_INPUT
public static final int AREATREE_INPUT
public static final int IF_INPUT
public static final int IMAGE_INPUT
Constructor Detail |
---|
public CommandLineOptions()
Method Detail |
---|
public boolean parse(java.lang.String[] args) throws FOPException, java.io.IOException
args
- the command line arguments.
FOPException
- for general errors
java.io.IOException
- if the the configuration file could not be loadedpublic InputHandler getInputHandler()
public org.apache.commons.logging.Log getLogger()
protected java.lang.String getOutputFormat() throws FOPException
FOPException
- for invalid output formatsprotected FOUserAgent getFOUserAgent()
public java.io.File getFOFile()
public java.io.File getXMLFile()
public java.io.File getXSLFile()
public java.io.File getOutputFile()
public java.io.File getUserConfigFile()
public java.lang.Boolean isCoarseAreaXml()
public boolean isInputFromStdIn()
public boolean isOutputToStdOut()
public java.io.File getInputFile()
public static void printUsage(java.io.PrintStream out)
out
- the stream to which the message must be printed
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |