01: /*
02: * SeparatorHandler.java: separator handling in tokenizers
03: *
04: * Copyright (C) 2002 Heiko Blau
05: *
06: * This file belongs to the JTopas Library.
07: * JTopas is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as published by the
09: * 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: // Interface SeparatorHandler
35: //
36:
37: /**<p>
38: * This interface declares the methods a {@link de.susebox.jtopas.Tokenizer} needs
39: * to deal with separators.
40: *</p><p>
41: * Separators are single characters that are either not very important in the
42: * tokenizing process or are sufficiently characterized by their token image.
43: * Examples are opening and closing parentheses, commas, semicolons etc. Their
44: * main feature is that they separate other tokens in the same way as whiterspaces
45: * and comments.
46: *
47: *</p>
48: *
49: * @see de.susebox.jtopas.Tokenizer
50: * @see de.susebox.jtopas.TokenizerProperties
51: * @see de.susebox.jtopas.spi.DataMapper
52: * @author Heiko Blau
53: */
54: public interface SeparatorHandler {
55:
56: /**
57: * This method checks if the character is a separator.
58: *
59: * @param testChar check this character
60: * @return <code>true</code> if the given character is a separator,
61: * <code>false</code> otherwise
62: * @see de.susebox.jtopas.TokenizerProperties#setSeparators
63: */
64: public boolean isSeparator(char testChar);
65: }
|