01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.lib.contract.lang.parser;
28:
29: import java.util.*;
30:
31: import org.cougaar.lib.contract.lang.*;
32:
33: /**
34: * A generic tree tokenizer, used as a buffer from a <code>TreeVisitor</code>.
35: */
36: public interface VisitTokenizer {
37:
38: /**
39: * Tokens.
40: */
41: public static final int TT_END = 0;
42: public static final int TT_END_OF_TREE = 1;
43: public static final int TT_WORD = 2;
44: public static final int TT_CONSTANT = 3;
45:
46: /**
47: * Move to the beginning.
48: */
49: public void rewind();
50:
51: /**
52: * Set the marker at the current point.
53: * @see #reset
54: */
55: public void mark();
56:
57: /**
58: * Move to the marker.
59: * @see #mark
60: */
61: public void reset();
62:
63: /**
64: * @return a TT_* constant.
65: */
66: public int nextToken();
67:
68: /**
69: * @return a TT_* constant.
70: */
71: public int previousToken();
72:
73: /**
74: * Should only be called if the current token is <tt>TT_WORD</tt>.
75: */
76: public String getWord();
77:
78: /**
79: * Should only be called if the current token is <tt>TT_CONSTANT</tt>.
80: */
81: public String getConstantType();
82:
83: /**
84: * Should only be called if the current token is <tt>TT_CONSTANT</tt>.
85: */
86: public String getConstantValue();
87: }
|