01: package org.ofbiz.rules.parse.tokens;
02:
03: import java.io.*;
04:
05: /**
06: * <p><b>Title:</b> Tokenizer State
07: * <p><b>Description:</b> None
08: * <p>Copyright (c) 1999 Steven J. Metsker.
09: * <p>Copyright (c) 2001 The Open For Business Project - www.ofbiz.org
10: *
11: * <p>Permission is hereby granted, free of charge, to any person obtaining a
12: * copy of this software and associated documentation files (the "Software"),
13: * to deal in the Software without restriction, including without limitation
14: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15: * and/or sell copies of the Software, and to permit persons to whom the
16: * Software is furnished to do so, subject to the following conditions:
17: *
18: * <p>The above copyright notice and this permission notice shall be included
19: * in all copies or substantial portions of the Software.
20: *
21: * <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22: * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
24: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
25: * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
26: * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
27: * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28: *
29: * <br>
30: * A tokenizerState returns a token, given a reader, an
31: * initial character read from the reader, and a tokenizer
32: * that is conducting an overall tokenization of the reader.
33: * The tokenizer will typically have a character state table
34: * that decides which state to use, depending on an initial
35: * character. If a single character is insufficient, a state
36: * such as <code>SlashState</code> will read a second
37: * character, and may delegate to another state, such as
38: * <code>SlashStarState</code>. This prospect of delegation is
39: * the reason that the <code>nextToken()</code> method has a
40: * tokenizer argument.
41: *
42: * @author Steven J. Metsker
43: * @version 1.0
44: */
45: public abstract class TokenizerState {
46:
47: /**
48: * Return a token that represents a logical piece of a reader.
49: *
50: * @return a token that represents a logical piece of the
51: * reader
52: * @param PushbackReader a reader to read from
53: * @param c the character that a tokenizer used to
54: * determine to use this state
55: * @param Tokenizer the tokenizer conducting the overall
56: * tokenization of the reader
57: * @exception IOException if there is any problem reading
58: */
59: public abstract Token nextToken(PushbackReader r, int c, Tokenizer t)
60: throws IOException;
61: }
|