net.sf.jsefa.rbf.annotation.RbfAnnotations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsefa-android Show documentation

JSefa (Java Simple exchange format api) is a simple library for stream-based serialization of java objects to XML, CSV, FLR or any other format and back again using an iterator-style interface independent of the serialization format. The mapping between java object types and types of the serialization format (e. g. xml complex element types) can be defined either by annotating the java classes or programmatically using a simple API. The current implementation supports XML, CSV and FLR - for XML it is based on JSR 173.

The newest version!

/*
 * Copyright 2007 the original author or authors.
 *
 * Licensed 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 net.sf.jsefa.rbf.annotation;

import java.lang.annotation.Annotation;

/**
 * Parameter object encapsulating the annotation classes to use.
 * 
 * Instances of this class are immutable and thread-safe.
 * 
 * @author Norman Lahme-Huetig
 * 
 */
public final class RbfAnnotations {

    private final Class dataTypeAnnotationClass;

    private final Class fieldAnnotationClass;

    private final Class subRecordAnnotationClass;

    private final Class subRecordListAnnotationClass;

    /**
     * Constructs a new RbfAnnotations object.
     * 
     * @param dataTypeAnnotationClass the data type annotation class
     * @param fieldAnnotationClass the field annotation class
     * @param subRecordAnnotationClass the sub record annotation class
     * @param subRecordListAnnotationClass the sub record list annotation class
     */
    public RbfAnnotations(Class dataTypeAnnotationClass,
            Class fieldAnnotationClass,
            Class subRecordAnnotationClass,
            Class subRecordListAnnotationClass) {
        this.dataTypeAnnotationClass = dataTypeAnnotationClass;
        this.fieldAnnotationClass = fieldAnnotationClass;
        this.subRecordAnnotationClass = subRecordAnnotationClass;
        this.subRecordListAnnotationClass = subRecordListAnnotationClass;
    }

    /**
     * Returns the data type annotation class.
     * 
     * @return the data type annotation class
     */
    public Class getDataTypeAnnotationClass() {
        return dataTypeAnnotationClass;
    }

    /**
     * Returns the field annotation class.
     * 
     * @return the field annotation class.
     */
    public Class getFieldAnnotationClass() {
        return fieldAnnotationClass;
    }

    /**
     * Returns the sub record annotation class.
     * 
     * @return the sub record annotation class
     */
    public Class getSubRecordAnnotationClass() {
        return subRecordAnnotationClass;
    }

    /**
     * Returns the sub record list annotation class.
     * 
     * @return the sub record list annotation class.
     */
    public Class getSubRecordListAnnotationClass() {
        return subRecordListAnnotationClass;
    }

}