com.sun.org.apache.xerces.internal.xs.XSAnnotation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxp-ri Show documentation
Show all versions of jaxp-ri Show documentation
Java API for XML Processing Reference Implementation
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.sun.org.apache.xerces.internal.xs;
/**
* This interface represents the Annotation schema component.
*/
public interface XSAnnotation extends XSObject {
// TargetType
/**
* The object type is org.w3c.dom.Element
.
*/
public static final short W3C_DOM_ELEMENT = 1;
/**
* The object type is org.xml.sax.ContentHandler
.
*/
public static final short SAX_CONTENTHANDLER = 2;
/**
* The object type is org.w3c.dom.Document
.
*/
public static final short W3C_DOM_DOCUMENT = 3;
/**
* Write contents of the annotation to the specified object. If the
* specified target
is a DOM object, in-scope namespace
* declarations for annotation
element are added as
* attribute nodes of the serialized annotation
, otherwise
* the corresponding events for all in-scope namespace declarations are
* sent via the specified document handler.
* @param target A target pointer to the annotation target object, i.e.
* org.w3c.dom.Document
, org.w3c.dom.Element
* , org.xml.sax.ContentHandler
.
* @param targetType A target type.
* @return True if the target
is a recognized type and
* supported by this implementation, otherwise false.
*/
public boolean writeAnnotation(Object target,
short targetType);
/**
* A text representation of the annotation.
*/
public String getAnnotationString();
}