01: /*
02: * Geotools2 - OpenSource mapping toolkit
03: * http://geotools.org
04: * (C) 2006, Geotools Project Managment Committee (PMC)
05: *
06: * This library is free software; you can redistribute it and/or
07: * modify it under the terms of the GNU Lesser General Public
08: * License as published by the Free Software Foundation;
09: * version 2.1 of the License.
10: *
11: * This library is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: */
16: package org.geotools.xml;
17:
18: import java.util.Map;
19:
20: /**
21: * Provides a mechanism to indicate that the XMLSAXHandler should stop
22: * parsing. It will periodically call shouldStop(), passing in its hints
23: * object. If shouldStop() returns true, if will abort parsing.
24: *
25: * @author Richard Gould
26: *
27: */
28: public interface FlowHandler {
29: /**
30: * If this method returns true, the XMLSAXHandler will abort parsing.
31: *
32: * @param hints the hints that were passed into the XML parser
33: * @return true if the XML parser should abort parsing
34: */
35: public boolean shouldStop(Map hints);
36: }
|