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;
22
23 /**
24 * This interface represents an entity, as declared in an XML DTD.
25 */
26 public interface Entity {
27
28 /**
29 * Returns the name of the entity, without the leading or trailing
30 * <code>&</code>, <code>%</code> or <code>;</code> characters.
31 *
32 * @return a <code>String</code> holding the name of the entity, without
33 * the leading <code>&</code> or <code>%</code> character and trailing
34 * <code>;</code> character.
35 */
36 String getName();
37
38 /**
39 * Returns the value of the entity.
40 *
41 * @return the <code>String</code> value of the replacement text for this
42 * entity
43 */
44 String getValue();
45
46 }