1 ////////////////////////////////////////////////////////////////////////////////
2 // MillScript-XML: an Open Spice interpreter and batch website creation tool
3 // Copyright (C) 2005 Kevin Rogers
4 //
5 // This file is part of MillScript-XML.
6 //
7 // MillScript-XML is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU General Public License as published by the Free
9 // Software Foundation; either version 2 of the License, or (at your option)
10 // any later version.
11 //
12 // MillScript-XML 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. See the GNU General Public License for
15 // more details.
16 //
17 // You should have received a copy of the GNU General Public License along with
18 // MillScript-XML; if not, write to the Free Software Foundation, Inc., 59 Temple
19 // Place, Suite 330, Boston, MA 02111-1307 USA
20 ////////////////////////////////////////////////////////////////////////////////
21 package org.millscript.commons.xml.api.token;
22
23 /**
24 * This interface represents a token that can be returned by the tokenizer. It
25 * allows us to provide an object oriented tokenizer and also provides us with
26 * a way to ensure the tokenizer only ever returns valid tokens.
27 * <p>
28 * By ensuring that every token implements the visitor pattern, we effectively
29 * unify the tokenizing and event style of parsing a document.
30 * </p>
31 */
32 public interface Token {
33
34 /**
35 * Visits the specified token visitor with this token.
36 *
37 * @param tokenVisitor the <code>TokenVisitor</code> to visit with this
38 * token
39 */
40 void visit( final TokenVisitor tokenVisitor );
41
42 }