pat

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>flavors.java.Parser</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.5.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> <script src="http://yui.yahooapis.com/combo?3.5.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title=""></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: </em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/cultures.deAT.html">cultures.deAT</a></li> <li><a href="../classes/cultures.deDE.html">cultures.deDE</a></li> <li><a href="../classes/cultures.enUS.html">cultures.enUS</a></li> <li><a href="../classes/flavors.java.html">flavors.java</a></li> <li><a href="../classes/flavors.java.Formatter.html">flavors.java.Formatter</a></li> <li><a href="../classes/flavors.java.Formatter.number.html">flavors.java.Formatter.number</a></li> <li><a href="../classes/flavors.java.Formatter.number.localize.html">flavors.java.Formatter.number.localize</a></li> <li><a href="../classes/flavors.java.Formatter.util.html">flavors.java.Formatter.util</a></li> <li><a href="../classes/flavors.java.Parser.html">flavors.java.Parser</a></li> <li><a href="../classes/flavors.java.Scanner.html">flavors.java.Scanner</a></li> <li><a href="../classes/flavors.java.Scanner.tokenCategories.html">flavors.java.Scanner.tokenCategories</a></li> <li><a href="../classes/Formatter.html">Formatter</a></li> <li><a href="../classes/Formatter.date.html">Formatter.date</a></li> <li><a href="../classes/Formatter.number.html">Formatter.number</a></li> <li><a href="../classes/Formatter.util.html">Formatter.util</a></li> <li><a href="../classes/Formatter.util.date.html">Formatter.util.date</a></li> <li><a href="../classes/Formatter.util.number.html">Formatter.util.number</a></li> </ul> <ul id="api-modules" class="apis modules"> <li><a href="../modules/cultures.html">cultures</a></li> <li><a href="../modules/flavors.html">flavors</a></li> <li><a href="../modules/pat.html">pat</a></li> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>flavors.java.Parser Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/.._lib_flavors_java.js.html#l776"><code>../lib/flavors/java.js:776</code></a> </div> Module: <a href="../modules/flavors.html">flavors</a><br> Parent Module: <a href="../modules/pat.html">pat</a> </div> <div class="box intro"> <p>Allocates a new Parser for Java format specifiers.</p> </div> <div class="constructor"> <h2>Constructor</h2> <div id="method_flavors.java.Parser" class="method item"> <h3 class="name"><code>flavors.java.Parser</code></h3> <span class="paren">()</span> <span class="returns-inline"> <span class="type">Parser</span> </span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l776"><code>../lib/flavors/java.js:776</code></a> </p> </div> <div class="description"> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: New Parser instance </div> </div> </div> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods"> <li class="index-item method"> <a href="#method_parse">parse</a> </li> <li class="index-item method"> <a href="#method_parseCharacter">parseCharacter</a> </li> <li class="index-item method"> <a href="#method_parseComputerizedScientificFloat">parseComputerizedScientificFloat</a> </li> <li class="index-item method"> <a href="#method_parseDatetime">parseDatetime</a> </li> <li class="index-item method"> <a href="#method_parseDecimalFloat">parseDecimalFloat</a> </li> <li class="index-item method"> <a href="#method_parseDecInt">parseDecInt</a> </li> <li class="index-item method"> <a href="#method_parseFloatingPoint">parseFloatingPoint</a> </li> <li class="index-item method"> <a href="#method_parseGeneral">parseGeneral</a> </li> <li class="index-item method"> <a href="#method_parseGeneralScientificFloat">parseGeneralScientificFloat</a> </li> <li class="index-item method"> <a href="#method_parseGeneralScientificFloat">parseGeneralScientificFloat</a> </li> <li class="index-item method"> <a href="#method_parseHexInt">parseHexInt</a> </li> <li class="index-item method"> <a href="#method_parseIntegral">parseIntegral</a> </li> <li class="index-item method"> <a href="#method_parseOctInt">parseOctInt</a> </li> <li class="index-item method"> <a href="#method_parseSymbolicNumber">parseSymbolicNumber</a> </li> <li class="index-item method"> <a href="#method_parseToken">parseToken</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_parse" class="method item"> <h3 class="name"><code>parse</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>input</code> </li> <li class="arg"> <code class="optional">[fmtArgs]</code> </li> <li class="arg"> <code class="optional">[fmtOpt]</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">String</span> </span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l1320"><code>../lib/flavors/java.js:1320</code></a> </p> </div> <div class="description"> <p>Parses the given input.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">input</code> <span class="type">String | Array</span> <div class="param-description"> <p>String or character array to be parsed</p> </div> </li> <li class="param"> <code class="param-name optional">[fmtArgs]</code> <span class="type">Array</span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>Data to be formatted</p> </div> </li> <li class="param"> <code class="param-name optional">[fmtOpt]</code> <span class="type">Object</span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">String</span>: Formatted data </div> </div> </div> <div id="method_parseCharacter" class="method item"> <h3 class="name"><code>parseCharacter</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l818"><code>../lib/flavors/java.js:818</code></a> </p> </div> <div class="description"> <p>Parses a format specifier of conversion type 'character'</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">String | Number</span> <div class="param-description"> <p>String or Unicode code point</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseComputerizedScientificFloat" class="method item"> <h3 class="name"><code>parseComputerizedScientificFloat</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l1000"><code>../lib/flavors/java.js:1000</code></a> </p> </div> <div class="description"> <p>Parses computerized scientific floats.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseDatetime" class="method item"> <h3 class="name"><code>parseDatetime</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l1106"><code>../lib/flavors/java.js:1106</code></a> </p> </div> <div class="description"> <p>Parses a format specifier of conversion type 'datetime'</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Date</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseDecimalFloat" class="method item"> <h3 class="name"><code>parseDecimalFloat</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l977"><code>../lib/flavors/java.js:977</code></a> </p> </div> <div class="description"> <p>Parses decimal floats.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseDecInt" class="method item"> <h3 class="name"><code>parseDecInt</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l863"><code>../lib/flavors/java.js:863</code></a> </p> </div> <div class="description"> <p>Parses a decimal integer.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseFloatingPoint" class="method item"> <h3 class="name"><code>parseFloatingPoint</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l1075"><code>../lib/flavors/java.js:1075</code></a> </p> </div> <div class="description"> <p>Parses a format specifier of conversion type 'floatingPoint'.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Any</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseGeneral" class="method item"> <h3 class="name"><code>parseGeneral</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l787"><code>../lib/flavors/java.js:787</code></a> </p> </div> <div class="description"> <p>Parses a format specifier of conversion type 'general'.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Any</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseGeneralScientificFloat" class="method item"> <h3 class="name"><code>parseGeneralScientificFloat</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l1025"><code>../lib/flavors/java.js:1025</code></a> </p> </div> <div class="description"> <p>Parses computerized scientific floats.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseGeneralScientificFloat" class="method item"> <h3 class="name"><code>parseGeneralScientificFloat</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>fmtArg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l1064"><code>../lib/flavors/java.js:1064</code></a> </p> </div> <div class="description"> <p>Parses hexadecimal exponential floats.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseHexInt" class="method item"> <h3 class="name"><code>parseHexInt</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l912"><code>../lib/flavors/java.js:912</code></a> </p> </div> <div class="description"> <p>Parses a hexadecimal integer.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseIntegral" class="method item"> <h3 class="name"><code>parseIntegral</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> <li class="arg"> <code>fmtOpt</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l949"><code>../lib/flavors/java.js:949</code></a> </p> </div> <div class="description"> <p>Parses a format specifier of conversion type 'integral'.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Any</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> <li class="param"> <code class="param-name">fmtOpt</code> <span class="type">Object</span> <div class="param-description"> <p>Format options</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseOctInt" class="method item"> <h3 class="name"><code>parseOctInt</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p> Defined in <a href="../files/.._lib_flavors_java.js.html#l882"><code>../lib/flavors/java.js:882</code></a> </p> </div> <div class="description"> <p>Parses an octal integer.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">token</code> <span class="type">Object</span> <div class="param-description"> <p>Token to be parsed</p> </div> </li> <li class="param"> <code class="param-name">fmtArg</code> <span class="type">Number</span> <div class="param-description"> <p>Value to be formatted</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">Parser</span>: </div> </div> </div> <div id="method_parseSymbolicNumber" class="method item"> <h3 class="name"><code>parseSymbolicNumber</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>token</code> </li> <li class="arg"> <code>fmtArg</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">Parser</span> </span> <span class="flag chainable">chainable</span> <div class="meta"> <p>