01: package org.ofbiz.rules.parse.tokens;
02:
03: import java.util.*;
04: import org.ofbiz.rules.parse.*;
05:
06: /**
07: * <p><b>Title:</b> Literal
08: * <p><b>Description:</b> None
09: * <p>Copyright (c) 1999 Steven J. Metsker.
10: * <p>Copyright (c) 2001 The Open For Business Project - www.ofbiz.org
11: *
12: * <p>Permission is hereby granted, free of charge, to any person obtaining a
13: * copy of this software and associated documentation files (the "Software"),
14: * to deal in the Software without restriction, including without limitation
15: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16: * and/or sell copies of the Software, and to permit persons to whom the
17: * Software is furnished to do so, subject to the following conditions:
18: *
19: * <p>The above copyright notice and this permission notice shall be included
20: * in all copies or substantial portions of the Software.
21: *
22: * <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23: * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24: * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25: * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
26: * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
27: * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
28: * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29: *
30: * <br>
31: * A Literal matches a specific String from an assembly.
32: *
33: * @author Steven J. Metsker
34: * @version 1.0
35: */
36: public class Literal extends Terminal {
37:
38: /**
39: * the literal to match
40: */
41: protected Token literal;
42:
43: /**
44: * Constructs a literal that will match the specified string.
45: *
46: * @param string the string to match as a token
47: *
48: * @return a literal that will match the specified string
49: */
50: public Literal(String s) {
51: literal = new Token(s);
52: }
53:
54: /**
55: * Returns true if the literal this object equals an
56: * assembly's next element.
57: *
58: * @param object an element from an assembly
59: *
60: * @return true, if the specified literal equals the next
61: * token from an assembly
62: */
63: protected boolean qualifies(Object o) {
64: return literal.equals((Token) o);
65: }
66:
67: /**
68: * Returns a textual description of this parser.
69: *
70: * @param vector a list of parsers already printed in
71: * this description
72: *
73: * @return string a textual description of this parser
74: *
75: * @see Parser#toString()
76: */
77: public String unvisitedString(List visited) {
78: return literal.toString();
79: }
80: }
|