<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:37 GMT 2011 --> <TITLE> CommandLineOptions </TITLE> <META NAME="date" CONTENT="2011-12-09"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="CommandLineOptions"; } } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <HR> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/trans/BuiltInRuleSet.html" title="interface in net.sf.saxon.trans"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/trans/CompilerInfo.html" title="class in net.sf.saxon.trans"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/trans/CommandLineOptions.html" target="_top"><B>FRAMES</B></A> <A HREF="CommandLineOptions.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> net.sf.saxon.trans</FONT> <BR> Class CommandLineOptions</H2> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.trans.CommandLineOptions</B> </PRE> <HR> <DL> <DT><PRE>public class <B>CommandLineOptions</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> </PRE> <P> This is a helper class for classes such as net.sf.saxon.Transform and net.sf.saxon.Query that process command line options <P> <P> <HR> <P> <!-- =========== FIELD SUMMARY =========== --> <A NAME="field_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Field Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_BOOLEAN">TYPE_BOOLEAN</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_CLASSNAME">TYPE_CLASSNAME</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_DATETIME">TYPE_DATETIME</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_ENUMERATION">TYPE_ENUMERATION</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_FILENAME">TYPE_FILENAME</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_FILENAME_LIST">TYPE_FILENAME_LIST</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_INTEGER">TYPE_INTEGER</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_INTEGER_PAIR">TYPE_INTEGER_PAIR</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_QNAME">TYPE_QNAME</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#TYPE_STRING">TYPE_STRING</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#VALUE_PROHIBITED">VALUE_PROHIBITED</A></B></CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#VALUE_REQUIRED">VALUE_REQUIRED</A></B></CODE> <BR> </TD> </TR> </TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#CommandLineOptions()">CommandLineOptions</A></B>()</CODE> <BR> </TD> </TR> </TABLE> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#addRecognizedOption(java.lang.String, int, java.lang.String)">addRecognizedOption</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> option, int optionProperties, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> helpText)</CODE> <BR> Set the permitted options.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#applyToConfiguration(net.sf.saxon.Configuration)">applyToConfiguration</A></B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config)</CODE> <BR> Apply options to the Configuration</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#definesParameterValues()">definesParameterValues</A></B>()</CODE> <BR> Test whether there is any keyword=value option present</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#displayPermittedOptions()">displayPermittedOptions</A></B>()</CODE> <BR> Display the list the permitted options</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#getOptionValue(java.lang.String)">getOptionValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> option)</CODE> <BR> Get the value of a named option.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#getPositionalOptions()">getPositionalOptions</A></B>()</CODE> <BR> Get the options specified positionally, that is, without a leading "-"</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#loadAdditionalSchemas(net.sf.saxon.Configuration, java.lang.String)">loadAdditionalSchemas</A></B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> additionalSchemas)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#loadDocuments(java.lang.String, boolean, net.sf.saxon.Configuration, boolean)">loadDocuments</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> sourceFileName, boolean useURLs, <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config, boolean useSAXSource)</CODE> <BR> Load a document, or all the documents in a directory, given a filename or URL</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#setActualOptions(java.lang.String[])">setActualOptions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args)</CODE> <BR> Set the options actually present on the command line</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#setParams(net.sf.saxon.Configuration, net.sf.saxon.Controller, net.sf.saxon.query.DynamicQueryContext, java.util.Properties)">setParams</A></B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config, <A HREF="../../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A> controller, <A HREF="../../../../net/sf/saxon/query/DynamicQueryContext.html" title="class in net.sf.saxon.query">DynamicQueryContext</A> qcontext, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> outputProperties)</CODE> <BR> Apply requested parameters to a controller, a query context, or a set of output properties, as appropriate</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#setPermittedValues(java.lang.String, java.lang.String[], java.lang.String)">setPermittedValues</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> option, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] values, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultValue)</CODE> <BR> Set the permitted values for an option</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#showExecutionTime(long)">showExecutionTime</A></B>(long millisecs)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#showExecutionTimeNano(long)">showExecutionTimeNano</A></B>(long nanosecs)</CODE> <BR> </TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../net/sf/saxon/trans/CommandLineOptions.html#testIfSchemaAware()">testIfSchemaAware</A></B>()</CODE> <BR> Prescan the command line arguments to see if any of them imply use of a schema-aware processor</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Field Detail</B></FONT></TH> </TR> </TABLE> <A NAME="TYPE_BOOLEAN"><!-- --></A><H3> TYPE_BOOLEAN</H3> <PRE> public static final int <B>TYPE_BOOLEAN</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_BOOLEAN">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_FILENAME"><!-- --></A><H3> TYPE_FILENAME</H3> <PRE> public static final int <B>TYPE_FILENAME</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_FILENAME">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_CLASSNAME"><!-- --></A><H3> TYPE_CLASSNAME</H3> <PRE> public static final int <B>TYPE_CLASSNAME</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_CLASSNAME">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_ENUMERATION"><!-- --></A><H3> TYPE_ENUMERATION</H3> <PRE> public static final int <B>TYPE_ENUMERATION</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_ENUMERATION">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_INTEGER"><!-- --></A><H3> TYPE_INTEGER</H3> <PRE> public static final int <B>TYPE_INTEGER</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_INTEGER">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_QNAME"><!-- --></A><H3> TYPE_QNAME</H3> <PRE> public static final int <B>TYPE_QNAME</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_QNAME">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_FILENAME_LIST"><!-- --></A><H3> TYPE_FILENAME_LIST</H3> <PRE> public static final int <B>TYPE_FILENAME_LIST</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_FILENAME_LIST">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_DATETIME"><!-- --></A><H3> TYPE_DATETIME</H3> <PRE> public static final int <B>TYPE_DATETIME</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_DATETIME">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_STRING"><!-- --></A><H3> TYPE_STRING</H3> <PRE> public static final int <B>TYPE_STRING</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_STRING">Constant Field Values</A></DL> </DL> <HR> <A NAME="TYPE_INTEGER_PAIR"><!-- --></A><H3> TYPE_INTEGER_PAIR</H3> <PRE> public static final int <B>TYPE_INTEGER_PAIR</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.TYPE_INTEGER_PAIR">Constant Field Values</A></DL> </DL> <HR> <A NAME="VALUE_REQUIRED"><!-- --></A><H3> VALUE_REQUIRED</H3> <PRE> public static final int <B>VALUE_REQUIRED</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.VALUE_REQUIRED">Constant Field Values</A></DL> </DL> <HR> <A NAME="VALUE_PROHIBITED"><!-- --></A><H3> VALUE_PROHIBITED</H3> <PRE> public static final int <B>VALUE_PROHIBITED</B></PRE> <DL> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.trans.CommandLineOptions.VALUE_PROHIBITED">Constant Field Values</A></DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="CommandLineOptions()"><!-- --></A><H3> CommandLineOptions</H3> <PRE> public <B>CommandLineOptions</B>()</PRE> <DL> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="addRecognizedOption(java.lang.String, int, java.lang.String)"><!-- --></A><H3> addRecognizedOption</H3> <PRE> public void <B>addRecognizedOption</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> option, int optionProperties, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> helpText)</PRE> <DL> <DD>Set the permitted options. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>option</CODE> - A permitted option.</DL> </DD> </DL> <HR> <A NAME="setPermittedValues(java.lang.String, java.lang.String[], java.lang.String)"><!-- --></A><H3> setPermittedValues</H3> <PRE> public void <B>setPermittedValues</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> option, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] values, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultValue)</PRE> <DL> <DD>Set the permitted values for an option <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>option</CODE> - the option keyword<DD><CODE>values</CODE> - the set of permitted values<DD><CODE>defaultValue</CODE> - the default value if the option is supplied but no value is given. May be null if no default is defined.</DL> </DD> </DL> <HR> <A NAME="setActualOptions(java.lang.String[])"><!-- --></A><H3> setActualOptions</H3> <PRE> public void <B>setActualOptions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] args) throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Set the options actually present on the command line <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>args</CODE> - the options supplied on the command line <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if an unrecognized or invalid option is found</DL> </DD> </DL> <HR> <A NAME="definesParameterValues()"><!-- --></A><H3> definesParameterValues</H3> <PRE> public boolean <B>definesParameterValues</B>()</PRE> <DL> <DD>Test whether there is any keyword=value option present <P> <DD><DL> <DT><B>Returns:</B><DD>true if there are any keyword=value options</DL> </DD> </DL> <HR> <A NAME="testIfSchemaAware()"><!-- --></A><H3> testIfSchemaAware</H3> <PRE> public boolean <B>testIfSchemaAware</B>()</PRE> <DL> <DD>Prescan the command line arguments to see if any of them imply use of a schema-aware processor <P> <DD><DL> <DT><B>Returns:</B><DD>true if a schema-aware processor is needed</DL> </DD> </DL> <HR> <A NAME="applyToConfiguration(net.sf.saxon.Configuration)"><!-- --></A><H3> applyToConfiguration</H3> <PRE> public void <B>applyToConfiguration</B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config) throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE> <DL> <DD>Apply options to the Configuration <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>config</CODE> - the Configuration <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if invalid options are present</DL> </DD> </DL> <HR> <A NAME="displayPermittedOptions()"><!-- --></A><H3> displayPermittedOptions</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>displayPermittedOptions</B>()</PRE> <DL> <DD>Display the list the permitted options <P> <DD><DL> <DT><B>Returns:</B><DD>the list of permitted options, as a string</DL> </DD> </DL> <HR> <A NAME="getOptionValue(java.lang.String)"><!-- --></A><H3> getOptionValue</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOptionValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> option)</PRE> <DL> <DD>Get the value of a named option. Returns null if the option was not present on the command line. Returns "" if the option was present but with no value ("-x" or "-x:"). <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>option</CODE> - the option keyword <DT><B>Returns:</B><DD>the option value, or null if not specified.</DL> </DD> </DL> <HR> <A NAME="getPositionalOptions()"><!-- --></A><H3> getPositionalOptions</H3> <PRE> public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>> <B>getPositionalOptions</B>()</PRE> <DL> <DD>Get the options specified positionally, that is, without a leading "-" <P> <DD><DL> <DT><B>Returns:</B><DD>the list of positional options</DL> </DD> </DL> <HR> <A NAME="setParams(net.sf.saxon.Configuration, net.sf.saxon.Controller, net.sf.saxon.query.DynamicQueryContext, java.util.Properties)"><!-- --></A><H3> setParams</H3> <PRE> public void <B>setParams</B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config, <A HREF="../../../../net/sf/saxon/Controller.html" title="class in net.sf.saxon">Controller</A> controller, <A HREF="../../../../net/sf/saxon/query/DynamicQueryContext.html" title="class in net.sf.saxon.query">DynamicQueryContext</A> qcontext, <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> outputProperties) throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE> <DL> <DD>Apply requested parameters to a controller, a query context, or a set of output properties, as appropriate <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>config</CODE> - the Saxon configuration<DD><CODE>controller</CODE> - The controller to be used for a transformation. May be null.<DD><CODE>qcontext</CODE> - The dynamic query context. May be null.<DD><CODE>outputProperties</CODE> - the serialization properties. May be null. <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if invalid options are found</DL> </DD> </DL> <HR> <A NAME="loadDocuments(java.lang.String, boolean, net.sf.saxon.Configuration, boolean)"><!-- --></A><H3> loadDocuments</H3> <PRE> public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>loadDocuments</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> sourceFileName, boolean useURLs, <A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config, boolean useSAXSource) throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE> <DL> <DD>Load a document, or all the documents in a directory, given a filename or URL <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>sourceFileName</CODE> - the name of the source file or directory<DD><CODE>useURLs</CODE> - true if the filename argument is to be treated as a URI<DD><CODE>config</CODE> - the Saxon configuration<DD><CODE>useSAXSource</CODE> - true if the method should use a SAXSource rather than a StreamSource <DT><B>Returns:</B><DD>if sourceFileName represents a single source document, return a Source object representing that document. If sourceFileName represents a directory, return a List containing multiple Source objects, one for each file in the directory. <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE> - if access to documents fails</DL> </DD> </DL> <HR> <A NAME="loadAdditionalSchemas(net.sf.saxon.Configuration, java.lang.String)"><!-- --></A><H3> loadAdditionalSchemas</H3> <PRE> public static void <B>loadAdditionalSchemas</B>(<A HREF="../../../../net/sf/saxon/Configuration.html" title="class in net.sf.saxon">Configuration</A> config, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> additionalSchemas) throws <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></PRE> <DL> <DD><DL> <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerException.html?is-external=true" title="class or interface in javax.xml.transform">TransformerException</A></CODE></DL> </DD> </DL> <HR> <A NAME="showExecutionTime(long)"><!-- --></A><H3> showExecutionTime</H3> <PRE> public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>showExecutionTime</B>(long millisecs)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <HR> <A NAME="showExecutionTimeNano(long)"><!-- --></A><H3> showExecutionTimeNano</H3> <PRE> public static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>showExecutionTimeNano</B>(long nanosecs)</PRE> <DL> <DD><DL> </DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../net/sf/saxon/trans/BuiltInRuleSet.html" title="interface in net.sf.saxon.trans"><B>PREV CLASS</B></A> <A HREF="../../../../net/sf/saxon/trans/CompilerInfo.html" title="class in net.sf.saxon.trans"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?net/sf/saxon/trans/CommandLineOptions.html" target="_top"><B>FRAMES</B></A> <A HREF="CommandLineOptions.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> Copyright (c) 2004-2011 Saxonica Limited. All rights reserved. </BODY> </HTML>