1 ////////////////////////////////////////////////////////////////////////////////
2 // MillScript: an Open Spice interpreter and batch website creation tool
3 // Copyright (C) 2001-2004 Open World Ltd
4 //
5 // This file is part of MillScript.
6 //
7 // MillScript 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 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; 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.millscript.datatypes;
22
23 import org.millscript.commons.util.IMap;
24
25 /**
26 * The MapAware interface should be implemented by any class which is not
27 * directly a Map, but may wrap one. Such an object could be viewed as a Map
28 * directly by ignoring the wrapping object. e.g. an XML element, which can be
29 * viewed as a Map of a child's position in the element to it's value.
30 */
31 public interface MapAware {
32
33 /**
34 * Returns this object as a Map.
35 *
36 * @return a Map for this object
37 */
38 IMap asMap();
39
40 }