|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/gnu.getopt-1.0.9/gnu/getopt/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>LongOpt (gnu.getopt JavaDoc)</title><script src="../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="gnu.getopt.LongOpt class"/><meta name="keywords" content="NO_ARGUMENT"/><meta name="keywords" content="REQUIRED_ARGUMENT"/><meta name="keywords" content="OPTIONAL_ARGUMENT"/><meta name="keywords" content="name"/><meta name="keywords" content="has_arg"/><meta name="keywords" content="flag"/><meta name="keywords" content="val"/><meta name="keywords" content="getName()"/><meta name="keywords" content="getHasArg()"/><meta name="keywords" content="getFlag()"/><meta name="keywords" content="getVal()"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../gnu/getopt/GetoptDemo.html">Prev Class</a> | Next Class</td><td class="navi"><a href="../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="LongOpt.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">gnu.getopt</h3><h1 class="class title-class">Class LongOpt</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>gnu.getopt.LongOpt</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">LongOpt</b></code></div><div class="class synopsis superclass"><code>extends Object</code></div></div><hr/><div class="class description"> This object represents the definition of a long option in the Java port
of GNU getopt. An array of LongOpt objects is passed to the Getopt
object to define the list of valid long options for a given parsing
session. Refer to the getopt documentation for details on the
format of long options.
</div><div class="taglet"><dl class="tag list"></dl><dt class="tag section header"><b>Version:</b></dt><dd>1.0.5</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Author:</b></dt><dd class="tag item">Aaron M. Renn (arenn@urbanophile.com)</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../gnu/getopt/Getopt.html"><code>Getopt</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#NO_ARGUMENT">NO_ARGUMENT</a></code></dt><dd class="description"> Constant value used for the "has_arg" constructor argument.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#OPTIONAL_ARGUMENT">OPTIONAL_ARGUMENT</a></code></dt><dd class="description"> Constant value used for the "has_arg" constructor argument.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#REQUIRED_ARGUMENT">REQUIRED_ARGUMENT</a></code></dt><dd class="description"> Constant value used for the "has_arg" constructor argument.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected StringBuffer</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#flag">flag</a></code></dt><dd class="description"> If this variable is not null, then the value stored in "val" is stored
here when this long option is encountered.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#has_arg">has_arg</a></code></dt><dd class="description"> Indicates whether the option has no argument, a required argument, or
an optional argument.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#name">name</a></code></dt><dd class="description"> The name of the long option
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#val">val</a></code></dt><dd class="description"> The value to store in "flag" if flag is not null, otherwise the
equivalent short option character for this long option.</dd></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#LongOpt(String,int,StringBuffer,int)">LongOpt</a>(String name, int has_arg, StringBuffer flag, int val)</code></dt><dd class="description"> Create a new LongOpt object with the given parameter values.</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> StringBuffer</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getFlag()">getFlag</a>()</code></dt><dd class="description"> Returns the value of the 'flag' field for this long option
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getHasArg()">getHasArg</a>()</code></dt><dd class="description"> Returns the value set for the 'has_arg' field for this long option
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getName()">getName</a>()</code></dt><dd class="description"> Returns the name of this LongOpt as a String
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getVal()">getVal</a>()</code></dt><dd class="description"> Returns the value of the 'val' field for this long option
</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="NO_ARGUMENT" id="NO_ARGUMENT"/><div class="member detail outer"><h3 class="member detail name">NO_ARGUMENT</h3><pre class="member detail synopsis">public static final int NO_ARGUMENT</pre><blockquote class="member detail name"><div class="member detail description"> Constant value used for the "has_arg" constructor argument. This
value indicates that the option takes no argument.
</div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">0</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="OPTIONAL_ARGUMENT" id="OPTIONAL_ARGUMENT"/><div class="member detail outer"><h3 class="member detail name">OPTIONAL_ARGUMENT</h3><pre class="member detail synopsis">public static final int OPTIONAL_ARGUMENT</pre><blockquote class="member detail name"><div class="member detail description"> Constant value used for the "has_arg" constructor argument. This
value indicates that the option takes an argument that is optional.
</div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">2</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="REQUIRED_ARGUMENT" id="REQUIRED_ARGUMENT"/><div class="member detail outer"><h3 class="member detail name">REQUIRED_ARGUMENT</h3><pre class="member detail synopsis">public static final int REQUIRED_ARGUMENT</pre><blockquote class="member detail name"><div class="member detail description"> Constant value used for the "has_arg" constructor argument. This
value indicates that the option takes an argument that is required.
</div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">1</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="flag" id="flag"/><div class="member detail outer"><h3 class="member detail name">flag</h3><pre class="member detail synopsis">protected StringBuffer flag</pre><blockquote class="member detail name"><div class="member detail description"> If this variable is not null, then the value stored in "val" is stored
here when this long option is encountered. If this is null, the value
stored in "val" is treated as the name of an equivalent short option.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="has_arg" id="has_arg"/><div class="member detail outer"><h3 class="member detail name">has_arg</h3><pre class="member detail synopsis">protected int has_arg</pre><blockquote class="member detail name"><div class="member detail description"> Indicates whether the option has no argument, a required argument, or
an optional argument.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="name" id="name"/><div class="member detail outer"><h3 class="member detail name">name</h3><pre class="member detail synopsis">protected String name</pre><blockquote class="member detail name"><div class="member detail description"> The name of the long option
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="val" id="val"/><div class="member detail outer"><h3 class="member detail name">val</h3><pre class="member detail synopsis">protected int val</pre><blockquote class="member detail name"><div class="member detail description"> The value to store in "flag" if flag is not null, otherwise the
equivalent short option character for this long option.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="LongOpt(String,int,StringBuffer,int)" id="LongOpt(String,int,StringBuffer,int)"/><div class="member detail outer"><h3 class="member detail name">LongOpt</h3><pre class="member detail synopsis">public LongOpt(String name,
int has_arg,
StringBuffer flag,
int val)
throws IllegalArgumentException</pre><blockquote class="member detail name"><div class="member detail description"> Create a new LongOpt object with the given parameter values. If the
value passed as has_arg is not valid, then an exception is thrown.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">name</code><span class="separator"> - </span><span class="description">The long option String.</span></dd><dd class="item"><code class="name">has_arg</code><span class="separator"> - </span><span class="description">Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT).</span></dd><dd class="item"><code class="name">flag</code><span class="separator"> - </span><span class="description">If non-null, this is a location to store the value of "val" when this option is encountered, otherwise "val" is treated as the equivalent short option character.</span></dd><dd class="item"><code class="name">val</code><span class="separator"> - </span><span class="description">The value to return for this long option, or the equivalent single letter option to emulate if flag is null.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="getFlag()" id="getFlag()"/><div class="member detail outer"><h3 class="member detail name">getFlag</h3><pre class="member detail synopsis">public StringBuffer getFlag()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the value of the 'flag' field for this long option
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The value of 'flag'</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getHasArg()" id="getHasArg()"/><div class="member detail outer"><h3 class="member detail name">getHasArg</h3><pre class="member detail synopsis">public int getHasArg()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the value set for the 'has_arg' field for this long option
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The value of 'has_arg'</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getName()" id="getName()"/><div class="member detail outer"><h3 class="member detail name">getName</h3><pre class="member detail synopsis">public String getName()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the name of this LongOpt as a String
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">Then name of the long option</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getVal()" id="getVal()"/><div class="member detail outer"><h3 class="member detail name">getVal</h3><pre class="member detail synopsis">public int getVal()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the value of the 'val' field for this long option
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The value of 'val'</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr></table></body></html>