1 /*
2 * Copyright (c) 2001-2004,
3 * RedVerst Group, ISP RAS http://www.ispras.ru
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice, this
10 * list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice,
13 * this list of conditions and the following disclaimer in the documentation
14 * and/or other materials provided with the distribution.
15 *
16 * 3. The names "ATP", "TreeDL", "RedVerst", "ISP RAS"
17 * may not be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 package com.unitesk.atp.text.filters;
33
34 /***
35 * Text filter receives portion of text, processes it and emit results to
36 * {@link TextReceiver client}.
37 * Text filter can be client of other filter so filters can be combined in chain to perform
38 * complicated text processing.
39 *
40 * @author <A href="mailto:demakov@ispras.ru">Alexey Demakov</A>
41 * @version $Id: Filter.java,v 1.1 2004/10/09 06:36:40 all-x Exp $
42 */
43 public class Filter implements TextReceiver
44 {
45 /***
46 * Constructs text filter with the specified client.
47 *
48 * @param client The client of this filter.
49 * @throws NullPointerException
50 * If <code>client</code> is <code>null</code>.
51 */
52 public Filter( TextReceiver client )
53 {
54 if( client == null )
55 {
56 throw new NullPointerException();
57 }
58
59 this.client = client;
60 }
61
62 /***
63 * Gets the client of this filter.
64 *
65 * @return The client of this filter.
66 */
67 public TextReceiver getClient()
68 {
69 return client;
70 }
71
72 //--------------------------------------------------------------------------
73 // interface TextReceiver
74
75 /***
76 * The default implementation passes input string
77 * to the client without any changes.
78 *
79 * @param s The string to process.
80 */
81 public void txt( String s )
82 {
83 client.txt( s );
84 }
85
86 /***
87 * The default implementation passes line separator
88 * to the client without any changes.
89 */
90 public void nl()
91 {
92 client.nl();
93 }
94
95 //--------------------------------------------------------------------------
96 // implementation
97
98 protected TextReceiver client;
99 }