KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xs > XSAnnotation


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 2003, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.xs;
59
60 /**
61  * This interface represents the Annotation schema component.
62  */
63 public interface XSAnnotation extends XSObject {
64     // TargetType
65 /**
66      * The object type is <code>org.w3c.dom.Element</code>.
67      */
68     public static final short W3C_DOM_ELEMENT = 1;
69     /**
70      * The object type is <code>org.xml.sax.ContentHandler</code>.
71      */
72     public static final short SAX_CONTENTHANDLER = 2;
73     /**
74      * The object type is <code>org.w3c.dom.Document</code>.
75      */
76     public static final short W3C_DOM_DOCUMENT = 3;
77
78     /**
79      * Write contents of the annotation to the specified object. If the
80      * specified <code>target</code> is a DOM object, in-scope namespace
81      * declarations for <code>annotation</code> element are added as
82      * attribute nodes of the serialized <code>annotation</code>, otherwise
83      * the corresponding events for all in-scope namespace declarations are
84      * sent via the specified document handler.
85      * @param target A target pointer to the annotation target object, i.e.
86      * <code>org.w3c.dom.Document</code>, <code>org.w3c.dom.Element</code>
87      * , <code>org.xml.sax.ContentHandler</code>.
88      * @param targetType A target type.
89      * @return True if the <code>target</code> is a recognized type and
90      * supported by this implementation, otherwise false.
91      */
92     public boolean writeAnnotation(Object JavaDoc target,
93                                    short targetType);
94
95     /**
96      * A text representation of the annotation.
97      */
98     public String JavaDoc getAnnotationString();
99
100 }
101
Popular Tags