jaxws/src/share/classes/com/sun/xml/internal/xsom/XSAnnotation.java
author tbell
Mon, 20 Apr 2009 15:14:39 -0700
changeset 2678 57cf2a1c1a05
parent 8 474761f14bca
child 3530 18fb7507984b
permissions -rw-r--r--
6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6 6672868: Package javax.xml.ws.wsaddressing not included in make/docs/CORE_PKGS.gmk Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8
474761f14bca Initial load
duke
parents:
diff changeset
     1
/*
2678
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
     2
 * Copyright 2005-2006 Sun Microsystems, Inc.  All Rights Reserved.
8
474761f14bca Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
474761f14bca Initial load
duke
parents:
diff changeset
     4
 *
474761f14bca Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
474761f14bca Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
474761f14bca Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
474761f14bca Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
474761f14bca Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
474761f14bca Initial load
duke
parents:
diff changeset
    10
 *
474761f14bca Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
474761f14bca Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
474761f14bca Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
474761f14bca Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
474761f14bca Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
474761f14bca Initial load
duke
parents:
diff changeset
    16
 *
474761f14bca Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
474761f14bca Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
474761f14bca Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
474761f14bca Initial load
duke
parents:
diff changeset
    20
 *
474761f14bca Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
474761f14bca Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
474761f14bca Initial load
duke
parents:
diff changeset
    23
 * have any questions.
474761f14bca Initial load
duke
parents:
diff changeset
    24
 */
474761f14bca Initial load
duke
parents:
diff changeset
    25
package com.sun.xml.internal.xsom;
474761f14bca Initial load
duke
parents:
diff changeset
    26
474761f14bca Initial load
duke
parents:
diff changeset
    27
import org.xml.sax.Locator;
474761f14bca Initial load
duke
parents:
diff changeset
    28
import com.sun.xml.internal.xsom.parser.AnnotationParser;
474761f14bca Initial load
duke
parents:
diff changeset
    29
474761f14bca Initial load
duke
parents:
diff changeset
    30
/**
474761f14bca Initial load
duke
parents:
diff changeset
    31
 * <a href="http://www.w3.org/TR/xmlschema-1/#Annotation_details">
474761f14bca Initial load
duke
parents:
diff changeset
    32
 * XML Schema annotation</a>.
474761f14bca Initial load
duke
parents:
diff changeset
    33
 *
474761f14bca Initial load
duke
parents:
diff changeset
    34
 *
474761f14bca Initial load
duke
parents:
diff changeset
    35
 */
474761f14bca Initial load
duke
parents:
diff changeset
    36
public interface XSAnnotation
474761f14bca Initial load
duke
parents:
diff changeset
    37
{
474761f14bca Initial load
duke
parents:
diff changeset
    38
    /**
474761f14bca Initial load
duke
parents:
diff changeset
    39
     * Obtains the application-parsed annotation.
474761f14bca Initial load
duke
parents:
diff changeset
    40
     * <p>
474761f14bca Initial load
duke
parents:
diff changeset
    41
     * annotations are parsed by the user-specified
474761f14bca Initial load
duke
parents:
diff changeset
    42
     * {@link AnnotationParser}.
474761f14bca Initial load
duke
parents:
diff changeset
    43
     *
474761f14bca Initial load
duke
parents:
diff changeset
    44
     * @return may return null
474761f14bca Initial load
duke
parents:
diff changeset
    45
     */
474761f14bca Initial load
duke
parents:
diff changeset
    46
    Object getAnnotation();
474761f14bca Initial load
duke
parents:
diff changeset
    47
474761f14bca Initial load
duke
parents:
diff changeset
    48
    /**
2678
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    49
     * Sets the value to be returned by {@link #getAnnotation()}.
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    50
     *
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    51
     * @param o
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    52
     *      can be null.
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    53
     * @return
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    54
     *      old value that was replaced by the <tt>o</tt>.
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    55
     */
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    56
    Object setAnnotation(Object o);
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    57
57cf2a1c1a05 6831313: update jaxws in OpenJDK7 to 2.1 plus bug fixes from OpenJDK 6
tbell
parents: 8
diff changeset
    58
    /**
8
474761f14bca Initial load
duke
parents:
diff changeset
    59
     * Returns a location information of the annotation.
474761f14bca Initial load
duke
parents:
diff changeset
    60
     */
474761f14bca Initial load
duke
parents:
diff changeset
    61
    Locator getLocator();
474761f14bca Initial load
duke
parents:
diff changeset
    62
}