KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > de > susebox > jtopas > spi > SeparatorHandler


1 /*
2  * SeparatorHandler.java: separator handling in tokenizers
3  *
4  * Copyright (C) 2002 Heiko Blau
5  *
6  * This file belongs to the JTopas Library.
7  * JTopas is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU Lesser General Public License as published by the
9  * Free Software Foundation; either version 2.1 of the License, or (at your
10  * option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.
15  * See the GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public License along
18  * with JTopas. If not, write to the
19  *
20  * Free Software Foundation, Inc.
21  * 59 Temple Place, Suite 330,
22  * Boston, MA 02111-1307
23  * USA
24  *
25  * or check the Internet: http://www.fsf.org
26  *
27  * Contact:
28  * email: heiko@susebox.de
29  */
30
31 package de.susebox.jtopas.spi;
32
33
34 //-----------------------------------------------------------------------------
35 // Interface SeparatorHandler
36 //
37
38 /**<p>
39  * This interface declares the methods a {@link de.susebox.jtopas.Tokenizer} needs
40  * to deal with separators.
41  *</p><p>
42  * Separators are single characters that are either not very important in the
43  * tokenizing process or are sufficiently characterized by their token image.
44  * Examples are opening and closing parentheses, commas, semicolons etc. Their
45  * main feature is that they separate other tokens in the same way as whiterspaces
46  * and comments.
47  *
48  *</p>
49  *
50  * @see de.susebox.jtopas.Tokenizer
51  * @see de.susebox.jtopas.TokenizerProperties
52  * @see de.susebox.jtopas.spi.DataMapper
53  * @author Heiko Blau
54  */
55 public interface SeparatorHandler {
56   
57   /**
58    * This method checks if the character is a separator.
59    *
60    * @param testChar check this character
61    * @return <code>true</code> if the given character is a separator,
62    * <code>false</code> otherwise
63    * @see de.susebox.jtopas.TokenizerProperties#setSeparators
64    */
65   public boolean isSeparator(char testChar);
66 }
67
Popular Tags