pat
Version:
Formats data described by format strings
769 lines (335 loc) • 17.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>flavors.java.Scanner</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.Scanner Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/.._lib_flavors_java.js.html#l306"><code>../lib/flavors/java.js:306</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 Scanner for Java format specifiers.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_flavors.java.Scanner" class="method item">
<h3 class="name"><code>flavors.java.Scanner</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>input</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Scanner</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_flavors_java.js.html#l306"><code>../lib/flavors/java.js:306</code></a>
</p>
</div>
<div class="description">
</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 scanned</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Scanner</span>:
New Scanner 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_err">err</a>
</li>
<li class="index-item method">
<a href="#method_hasNext">hasNext</a>
</li>
<li class="index-item method">
<a href="#method_input">input</a>
</li>
<li class="index-item method">
<a href="#method_next">next</a>
</li>
<li class="index-item method">
<a href="#method_reset">reset</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_err" class="method item">
<h3 class="name"><code>err</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>hint</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_flavors_java.js.html#l410"><code>../lib/flavors/java.js:410</code></a>
</p>
</div>
<div class="description">
<p>Throws an error using the given hint for the error message.
The error message includes the relevant input substring, the index of
the error prone character within the input, and the given hint.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">hint</code>
<span class="type">String</span>
<div class="param-description">
<p>To be included in the error message</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_hasNext" class="method item">
<h3 class="name"><code>hasNext</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Boolean</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_flavors_java.js.html#l709"><code>../lib/flavors/java.js:709</code></a>
</p>
</div>
<div class="description">
<p>Returns true if it's possible to scan another token, false otherwise.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Boolean</span>:
</div>
</div>
</div>
<div id="method_input" class="method item">
<h3 class="name"><code>input</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code class="optional">[input]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Scanner | Array</span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_flavors_java.js.html#l396"><code>../lib/flavors/java.js:396</code></a>
</p>
</div>
<div class="description">
<p>Sets or returns this Scanner's input.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[input]</code>
<span class="type">String | Array</span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>String or character array to be scanned</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Scanner | Array</span>:
This Scanner if called as setter, this Scanner's
current input if called as getter.
</div>
</div>
</div>
<div id="method_next" class="method item">
<h3 class="name"><code>next</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Object</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_flavors_java.js.html#l720"><code>../lib/flavors/java.js:720</code></a>
</p>
</div>
<div class="description">
<p>Returns the next token or undefined if there is no more text to scan.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Object</span>:
</div>
</div>
</div>
<div id="method_reset" class="method item">
<h3 class="name"><code>reset</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type">Scanner</span>
</span>
<span class="flag chainable">chainable</span>
<div class="meta">
<p>
Defined in
<a href="../files/.._lib_flavors_java.js.html#l380"><code>../lib/flavors/java.js:380</code></a>
</p>
</div>
<div class="description">
<p>Resets this Scanner's state.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">Scanner</span>:
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>