1/*
2 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.xml.internal.xsom;
27
28import org.xml.sax.Locator;
29import com.sun.xml.internal.xsom.parser.AnnotationParser;
30
31/**
32 * <a href="http://www.w3.org/TR/xmlschema-1/#Annotation_details">
33 * XML Schema annotation</a>.
34 *
35 *
36 */
37public interface XSAnnotation
38{
39    /**
40     * Obtains the application-parsed annotation.
41     * <p>
42     * annotations are parsed by the user-specified
43     * {@link AnnotationParser}.
44     *
45     * @return may return null
46     */
47    Object getAnnotation();
48
49    /**
50     * Sets the value to be returned by {@link #getAnnotation()}.
51     *
52     * @param o
53     *      can be null.
54     * @return
55     *      old value that was replaced by the {@code o}.
56     */
57    Object setAnnotation(Object o);
58
59    /**
60     * Returns a location information of the annotation.
61     */
62    Locator getLocator();
63}
64