KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > oro > text > regex > Pattern


1 package org.apache.oro.text.regex;
2
3 /* ====================================================================
4  * The Apache Software License, Version 1.1
5  *
6  * Copyright (c) 2000 The Apache Software Foundation. All rights
7  * reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution,
22  * if any, must include the following acknowledgment:
23  * "This product includes software developed by the
24  * Apache Software Foundation (http://www.apache.org/)."
25  * Alternately, this acknowledgment may appear in the software itself,
26  * if and wherever such third-party acknowledgments normally appear.
27  *
28  * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
29  * must not be used to endorse or promote products derived from this
30  * software without prior written permission. For written
31  * permission, please contact apache@apache.org.
32  *
33  * 5. Products derived from this software may not be called "Apache"
34  * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
35  * name, without prior written permission of the Apache Software Foundation.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals on behalf of the Apache Software Foundation. For more
53  * information on the Apache Software Foundation, please see
54  * <http://www.apache.org/>.
55  *
56  * Portions of this software are based upon software originally written
57  * by Daniel F. Savarese. We appreciate his contributions.
58  */
59
60 /**
61  * The Pattern interface allows multiple representations of a regular
62  * expression to be defined. In general, different regular expression
63  * compilers will produce different types of pattern representations.
64  * Some will produce state transition tables derived from syntax trees,
65  * others will produce byte code representations of an NFA, etc. The
66  * Pattern interface does not impose any specific internal pattern
67  * representation, and consequently, Pattern implementations are not meant
68  * to be interchangeable among differing PatternCompiler and PatternMatcher
69  * implementations. The documentation accompanying a specific implementation
70  * will define what other classes a Pattern can interact with.
71
72  @author <a HREF="dfs@savarese.org">Daniel F. Savarese</a>
73  @version $Id: Pattern.java,v 1.1.1.1 2000/07/23 23:08:51 jon Exp $
74
75  * @see PatternCompiler
76  * @see PatternMatcher
77  */
78 public interface Pattern {
79
80   /**
81    * This method returns the string representation of the pattern. Its
82    * purpose is to allow a pattern to be reconstructed after compilation.
83    * In other words, when you compile a pattern, the resulting data
84    * structures bear no relation to the string defining the pattern.
85    * It is often useful to be able to access the string defining a pattern
86    * after it has been compiled.
87    * <p>
88    * @return The original string representation of the regular expression
89    * pattern.
90    */
91   public String JavaDoc getPattern();
92
93
94
95   /**
96    * This method returns an integer containing the compilation options used
97    * to compile this pattern.
98    * <p>
99    * @return The compilation options used to compile the pattern.
100    */
101   public int getOptions();
102 }
103
Popular Tags