001: /*
002: * $Id: MatchActionInfo.java,v 1.8 2003/11/07 20:16:24 dfs Exp $
003: *
004: * ====================================================================
005: * The Apache Software License, Version 1.1
006: *
007: * Copyright (c) 2000 The Apache Software Foundation. All rights
008: * reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions
012: * are met:
013: *
014: * 1. Redistributions of source code must retain the above copyright
015: * notice, this list of conditions and the following disclaimer.
016: *
017: * 2. Redistributions in binary form must reproduce the above copyright
018: * notice, this list of conditions and the following disclaimer in
019: * the documentation and/or other materials provided with the
020: * distribution.
021: *
022: * 3. The end-user documentation included with the redistribution,
023: * if any, must include the following acknowledgment:
024: * "This product includes software developed by the
025: * Apache Software Foundation (http://www.apache.org/)."
026: * Alternately, this acknowledgment may appear in the software itself,
027: * if and wherever such third-party acknowledgments normally appear.
028: *
029: * 4. The names "Apache" and "Apache Software Foundation", "Jakarta-Oro"
030: * must not be used to endorse or promote products derived from this
031: * software without prior written permission. For written
032: * permission, please contact apache@apache.org.
033: *
034: * 5. Products derived from this software may not be called "Apache"
035: * or "Jakarta-Oro", nor may "Apache" or "Jakarta-Oro" appear in their
036: * name, without prior written permission of the Apache Software Foundation.
037: *
038: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
039: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
040: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
041: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
042: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
043: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
044: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
045: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
046: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
047: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
048: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
049: * SUCH DAMAGE.
050: * ====================================================================
051: *
052: * This software consists of voluntary contributions made by many
053: * individuals on behalf of the Apache Software Foundation. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package org.apache.oro.text;
059:
060: import java.util.*;
061: import java.io.*;
062:
063: import org.apache.oro.text.regex.*;
064:
065: /**
066: * This class is used to provide information regarding a match found by
067: * MatchActionProcessor to a MatchAction callback implementation.
068: *
069: * @version @version@
070: * @since 1.0
071: * @see MatchAction
072: * @see MatchActionProcessor
073: */
074: public final class MatchActionInfo {
075: /** The line number of the matching line */
076: public int lineNumber;
077:
078: /**
079: * The String representation of the matching line with the trailing
080: * newline truncated.
081: */
082: public String line;
083:
084: /**
085: * The char[] representation of the matching line with the trailing
086: * newline truncated.
087: */
088: public char[] charLine;
089:
090: /**
091: * The field separator used by the MatchActionProcessor. This will be
092: * set to null by a MatchActionProcessor instance if no field separator
093: * was specified before match processing began.
094: */
095: public Pattern fieldSeparator;
096:
097: /**
098: * A List of Strings containing the fields of the line that were
099: * separated out by the fieldSeparator. If no field separator was
100: * specified, this variable will be set to null.
101: */
102: public List fields;
103:
104: /** The PatternMatcher used to find the match. */
105: public PatternMatcher matcher;
106:
107: /**
108: * The pattern found in the line of input. If a MatchAction callback
109: * is registered with a null pattern (meaning the callback should be
110: * applied to every line of input), this value will be null.
111: */
112: public Pattern pattern;
113:
114: /**
115: * The first match found in the line of input. If a MatchAction callback
116: * is registered with a null pattern (meaning the callback should be
117: * applied to every line of input), this value will be null.
118: */
119: public MatchResult match;
120:
121: /** The output stream passed to the MatchActionProcessor. */
122: public PrintWriter output;
123:
124: /**
125: * The input stream passed to the MatchActionProcessor from which the
126: * matching line was read.
127: */
128: public BufferedReader input;
129: }
|