/*

 * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.xml.internal.xsom;

import org.xml.sax.Locator;

import com.sun.xml.internal.xsom.parser.AnnotationParser;

/**

 * <a href="http://www.w3.org/TR/xmlschema-1/#Annotation_details">

 * XML Schema annotation</a>.

 *

 *

 */

public interface XSAnnotation

{

    /**

     * Obtains the application-parsed annotation.

     * <p>

     * annotations are parsed by the user-specified

     * {@link AnnotationParser}.

     *

     * @return may return null

     */

    Object getAnnotation();

    /**

     * Sets the value to be returned by {@link #getAnnotation()}.

     *

     * @param o

     *      can be null.

     * @return

     *      old value that was replaced by the <tt>o</tt>.

     */

    Object setAnnotation(Object o);

    /**

     * Returns a location information of the annotation.

     */

    Locator getLocator();

}