01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package org.apache.xerces.xs;
19:
20: /**
21: * This interface represents the Annotation schema component.
22: */
23: public interface XSAnnotation extends XSObject {
24: // TargetType
25: /**
26: * The object type is <code>org.w3c.dom.Element</code>.
27: */
28: public static final short W3C_DOM_ELEMENT = 1;
29: /**
30: * The object type is <code>org.xml.sax.ContentHandler</code>.
31: */
32: public static final short SAX_CONTENTHANDLER = 2;
33: /**
34: * The object type is <code>org.w3c.dom.Document</code>.
35: */
36: public static final short W3C_DOM_DOCUMENT = 3;
37:
38: /**
39: * Write contents of the annotation to the specified object. If the
40: * specified <code>target</code> is a DOM object, in-scope namespace
41: * declarations for <code>annotation</code> element are added as
42: * attribute nodes of the serialized <code>annotation</code>, otherwise
43: * the corresponding events for all in-scope namespace declarations are
44: * sent via the specified document handler.
45: * @param target A target pointer to the annotation target object, i.e.
46: * <code>org.w3c.dom.Document</code>, <code>org.w3c.dom.Element</code>
47: * , <code>org.xml.sax.ContentHandler</code>.
48: * @param targetType A target type.
49: * @return True if the <code>target</code> is a recognized type and
50: * supported by this implementation, otherwise false.
51: */
52: public boolean writeAnnotation(Object target, short targetType);
53:
54: /**
55: * A text representation of the annotation.
56: */
57: public String getAnnotationString();
58:
59: }
|