KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jga > parser > IParser


1 // ============================================================================
2 // $Id: IParser.java,v 1.5 2005/08/02 23:45:05 davidahall Exp $
3 // Copyright (c) 2005 David A. Hall
4 // ============================================================================
5 // The contents of this file are subject to the Common Development and
6 // Distribution License (CDDL), Version 1.0 (the License); you may not use this
7 // file except in compliance with the License. You should have received a copy
8 // of the the License along with this file: if not, a copy of the License is
9 // available from Sun Microsystems, Inc.
10 //
11 // http://www.sun.com/cddl/cddl.html
12 //
13 // From time to time, the license steward (initially Sun Microsystems, Inc.) may
14 // publish revised and/or new versions of the License. You may not use,
15 // distribute, or otherwise make this file available under subsequent versions
16 // of the License.
17 //
18 // Alternatively, the contents of this file may be used under the terms of the
19 // GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which
20 // case the provisions of the LGPL are applicable instead of those above. If you
21 // wish to allow use of your version of this file only under the terms of the
22 // LGPL, and not to allow others to use your version of this file under the
23 // terms of the CDDL, indicate your decision by deleting the provisions above
24 // and replace them with the notice and other provisions required by the LGPL.
25 // If you do not delete the provisions above, a recipient may use your version
26 // of this file under the terms of either the CDDL or the LGPL.
27 //
28 // This library is distributed in the hope that it will be useful,
29 // but WITHOUT ANY WARRANTY; without even the implied warranty of
30 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
31 // ============================================================================
32
33 package net.sf.jga.parser;
34
35 import net.sf.jga.fn.BinaryFunctor;
36 import net.sf.jga.fn.Generator;
37 import net.sf.jga.fn.UnaryFunctor;
38
39 /**
40  * IParser.java
41  * <p>
42  * Copyright &copy; 2005 David A. Hall
43  * @deprecated This interface will be renamed to FunctorParser in a future release.
44  */
45
46 public interface IParser {
47
48     /**
49      * Parses the string to create a Generator.
50      */
51     public Generator parseGenerator(String JavaDoc str) throws ParseException;
52     
53     /**
54      * Parses the string to create a UnaryFunctor that takes an argument of the
55      * given type.
56      */
57     public UnaryFunctor parseUnary(String JavaDoc str, Class JavaDoc argType) throws ParseException;
58
59     /**
60      * Parses the string to create a BinaryFunctor that takes arguments of the
61      * given types.
62      */
63     public BinaryFunctor parseBinary(String JavaDoc str, Class JavaDoc arg1Type, Class JavaDoc arg2Type)
64         throws ParseException;
65     
66     /**
67      * Returns the type of object returned by the last functor parsed.
68      * @throws IllegalStateException if the parser has not been used or if
69      * parsing the last functor resulted in an exception being thrown.
70      */
71     public Class JavaDoc getReturnType();
72 }
73
Popular Tags