net.sf.jsefa.xml.mapping.TextContentMapping 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.xml.mapping;

import net.sf.jsefa.common.mapping.FieldDescriptor;
import net.sf.jsefa.common.validator.Validator;
import net.sf.jsefa.xml.lowlevel.TextMode;
import net.sf.jsefa.xml.namespace.QName;

/**
 * A mapping between an XML text node and a java object. This mapping is used for serialization and
 * deserialization.
 * 
 * Instances of this class are immutable and thread safe.
 * 
 * @author Norman Lahme-Huetig
 * @author Matthias Derer
 * 
 */
public final class TextContentMapping extends XmlNodeMapping {

    private final TextMode textMode;

    /**
     * Constructs a new TextContentMapping for the given data type name, text content descriptor and
     * field descriptor.
     * 
     * @param dataTypeName the name of the data type.
     * @param textContentDescriptor the descriptor of the attribute node
     * @param fieldDescriptor the descriptor of the field
     * @param validator the validator; may be null
     * @param textMode the text mode
     */
    public TextContentMapping(QName dataTypeName, TextContentDescriptor textContentDescriptor,
            FieldDescriptor fieldDescriptor, Validator validator, TextMode textMode) {
        super(dataTypeName, textContentDescriptor, fieldDescriptor.getObjectType(), fieldDescriptor,
                validator);
        this.textMode = textMode;
    }

    /**
     * Returns the text mode.
     * 
     * @return the text mode.
     */
    public TextMode getTextMode() {
        return textMode;
    }

}