01: /*
02:
03: Licensed to the Apache Software Foundation (ASF) under one or more
04: contributor license agreements. See the NOTICE file distributed with
05: this work for additional information regarding copyright ownership.
06: The ASF licenses this file to You under the Apache License, Version 2.0
07: (the "License"); you may not use this file except in compliance with
08: the License. You may obtain a copy of the License at
09:
10: http://www.apache.org/licenses/LICENSE-2.0
11:
12: Unless required by applicable law or agreed to in writing, software
13: distributed under the License is distributed on an "AS IS" BASIS,
14: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15: See the License for the specific language governing permissions and
16: limitations under the License.
17:
18: */
19: package org.apache.batik.dom;
20:
21: /**
22: * This is a Service interface for classes that want to extend the
23: * functionality of the AbstractDocument, to support new tags in the
24: * DOM tree.
25: *
26: * @author <a href="mailto:thomas.deweese@kodak.com">Thomas DeWeese</a>
27: * @version $Id: DomExtension.java 478249 2006-11-22 17:29:37Z dvholten $
28: */
29: public interface DomExtension {
30:
31: /**
32: * Return the priority of this Extension. Extensions are
33: * registered from lowest to highest priority. So if for some
34: * reason you need to come before/after another existing extension
35: * make sure your priority is lower/higher than theirs.
36: */
37: float getPriority();
38:
39: /**
40: * This should return the individual or company name responsible
41: * for the this implementation of the extension.
42: */
43: String getAuthor();
44:
45: /**
46: * This should return a contact address (usually an e-mail address).
47: */
48: String getContactAddress();
49:
50: /**
51: * This should return a URL where information can be obtained on
52: * this extension.
53: */
54: String getURL();
55:
56: /**
57: * Human readable description of the extension.
58: * Perhaps that should be a resource for internationalization?
59: * (although I suppose it could be done internally)
60: */
61: String getDescription();
62:
63: /**
64: * This method should update the DOMImplementation with support
65: * for the tags in this extension. In some rare cases it may
66: * be necessary to replace existing tag handlers, although this
67: * is discouraged.
68: *
69: * This is called before the DOMImplementation starts.
70: *
71: * @param di The DOMImplementation instance to be updated
72: */
73: void registerTags(ExtensibleDOMImplementation di);
74: }
|