KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > oro > text > MatchActionInfo


1 package org.apache.oro.text;
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 import java.util.*;
61 import java.io.*;
62
63 import org.apache.oro.text.regex.*;
64
65 /**
66  * This class is used to provide information regarding a match found by
67  * MatchActionProcessor to a MatchAction callback implementation.
68
69  @author <a HREF="dfs@savarese.org">Daniel F. Savarese</a>
70  @version $Id: MatchActionInfo.java,v 1.1.1.1 2000/07/23 23:08:49 jon Exp $
71
72  * @see MatchAction
73  * @see MatchActionProcessor
74  */
75 public final class MatchActionInfo {
76   /** The line number of the matching line */
77   public int lineNumber;
78
79   /**
80    * The String representation of the matching line with the trailing
81    * newline truncated.
82    */
83   public String JavaDoc line;
84
85   /**
86    * The char[] representation of the matching line with the trailing
87    * newline truncated.
88    */
89   public char[] charLine;
90
91   /**
92    * The field separator used by the MatchActionProcessor. This will be
93    * set to null by a MatchActionProcessor instance if no field separator
94    * was specified before match processing began.
95    */
96   public Pattern fieldSeparator;
97
98   /**
99    * A Vector of Strings containing the fields of the line that were
100    * separated out by the fieldSeparator. If no field separator was
101    * specified, this variable will be set to null.
102    */
103   public Vector fields;
104
105   /** The PatternMatcher used to find the match. */
106   public PatternMatcher matcher;
107
108   /**
109    * The pattern found in the line of input. If a MatchAction callback
110    * is registered with a null pattern (meaning the callback should be
111    * applied to every line of input), this value will be null.
112    */
113   public Pattern pattern;
114
115   /**
116    * The first match found in the line of input. If a MatchAction callback
117    * is registered with a null pattern (meaning the callback should be
118    * applied to every line of input), this value will be null.
119    */
120   public MatchResult match;
121
122   /** The output stream passed to the MatchActionProcessor. */
123   public PrintWriter output;
124
125   /**
126    * The input stream passed to the MatchActionProcessor from which the
127    * matching line was read.
128    */
129   public BufferedReader input;
130 }
131
132
Popular Tags