org.exquery.annotation.AbstractAnnotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of exquery-annotations-common Show documentation
Common EXQuery Annotations code
There is a newer version: 0.2.1
Show newest version
/**
 * Copyright © 2012, Adam Retter / EXQuery
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the  nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.exquery.annotation;

import javax.xml.namespace.QName;
import org.exquery.xquery.Literal;
import org.exquery.xquery3.Annotation;
import org.exquery.xquery3.FunctionSignature;

/**
 * Base Class for EXQuery Annotation Implementations
 *
 * @param  The Class to use for Exceptions
 * 
 * @author Adam Retter
 */
public abstract class AbstractAnnotation implements Annotation {
    private FunctionSignature functionSignature;
    private Literal[] literals;
    private QName name;
    
    /**
     * Initialises an Annotation
     * By default this does nothing, but a sub-class may override
     * 
     * @throws E if the Annotation could not be initialised
     */
    public void initialise() throws E {
    }
    
    //
    @Override
    public FunctionSignature getFunctionSignature() {
        return functionSignature;
    }
    
    public void setFunctionSignature(final FunctionSignature functionSignature) {
        this.functionSignature = functionSignature;
    }

    @Override
    public Literal[] getLiterals() {
        return literals;
    }
    
    public void setLiterals(final Literal[] literals) {
        this.literals = literals;
    }

    @Override
    public QName getName() {
        return name;
    }

    public void setName(final QName name) {
        this.name = name;
    }
    //
}