01: /*
02: * Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.xml.internal.xsom.parser;
27:
28: import org.xml.sax.ContentHandler;
29: import org.xml.sax.EntityResolver;
30: import org.xml.sax.ErrorHandler;
31:
32: /**
33: * Used to parse <xs:annotation>.
34: *
35: * @author Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
36: */
37: public abstract class AnnotationParser {
38: /**
39: * Called every time a new <xs:annotation> element
40: * is found.
41: *
42: * The sub-tree rooted at <xs:annotation> will be
43: * sent to this ContentHandler as if it is a whole document.
44: *
45: * @param context
46: * indicates the schema component that owns this annotation.
47: * Always non-null.
48: * @param parentElementName
49: * local name of the element that contains <xs:annotation>.
50: * (e.g., "element", "attribute", ... )
51: * @param errorHandler
52: * The error handler that the client application specifies.
53: * The returned content handler can send its errors to this
54: * object.
55: * @param entityResolver
56: * The entity resolver that is currently in use. Again,
57: * The returned content handler can use this object
58: * if it needs to resolve entities.
59: */
60: public abstract ContentHandler getContentHandler(
61: AnnotationContext context, String parentElementName,
62: ErrorHandler errorHandler, EntityResolver entityResolver);
63:
64: /**
65: * Once the SAX events are fed to the ContentHandler,
66: * this method will be called to retrieve the parsed result.
67: *
68: * @param existing
69: * An annotation object which was returned from another
70: * AnnotationParser before. Sometimes, one schema component
71: * can have multiple <:xs:annotation> elements and
72: * this parameter is used to merge all those annotations
73: * together. If there is no existing object, null will be
74: * passed.
75: * @return
76: * Any object, including null.
77: */
78: public abstract Object getResult(Object existing);
79: }
|