net.sf.jsefa.common.mapping.EntryPoint 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.common.mapping;

import net.sf.jsefa.Deserializer;
import net.sf.jsefa.Serializer;
import net.sf.jsefa.common.validator.Validator;

/**
 * An entry point describes an item of the respective format that should be serialized or deserialized. An entry
 * point is required for every type of object which will be passed to {@link Serializer#write} or which should be
 * returned from {@link Deserializer#next} and only for these objects (not for the objects related to these ones).
 * 
 * Each entry point consists of the following parts:

 * 1) A data type name which unambiguously maps to a {@link TypeMapping}.

 * 2) A designator that designates the item of the respective format (e. g. the name of the xml element).
 * 3) An optional {@link Validator}.
 * 
 * 
 * Instances of this class are immutable and thread-safe. This must be true for all subclasses, too.
 * 
 * @author Norman Lahme-Huetig
 * 
 * @param  the type of the data type name
 * @param  the type of the designator
 * 
 */
public class EntryPoint {

    private final T dataTypeName;

    private final D designator;
    
    private final Validator validator;

    /**
     * Constructs a entry point given data type name and a designator.
     * 
     * @param dataTypeName the data type name
     * @param designator the designator
     * @param validator the validator; may be null
     */
    public EntryPoint(T dataTypeName, D designator, Validator validator) {
        this.dataTypeName = dataTypeName;
        this.designator = designator;
        this.validator = validator;
    }

    /**
     * Returns the designator.
     * 
     * @return the designator
     */
    public final D getDesignator() {
        return this.designator;
    }

    /**
     * Returns the data type name.
     * 
     * @return the data type name
     */
    public final T getDataTypeName() {
        return this.dataTypeName;
    }
    
    /**
     * Returns the validator.
     * @return the validator or null if none exists.
     */
    public final Validator getValidator() {
        return this.validator;
    }
}