net.sf.jsefa.xml.annotation.XmlTextContent Maven / Gradle / Ivy

Go to download
/*
 * 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.annotation;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import net.sf.jsefa.common.annotation.NoConverterType;
import net.sf.jsefa.common.annotation.NoValidatorType;
import net.sf.jsefa.common.annotation.SimpleListItem;
import net.sf.jsefa.common.converter.SimpleTypeConverter;
import net.sf.jsefa.common.validator.Validator;
import net.sf.jsefa.xml.lowlevel.TextMode;

/**
 * An annotation stating that the annotated java field should be mapped to the content of the xml node with the
 * data type described by the class the annotated field is part of.
 * 
 * 
 * @author Norman Lahme-Huetig
 * @author Matthias Derer
 * 
 */
@Retention(RUNTIME)
@Target({FIELD})
public @interface XmlTextContent {
    /**
     * The format to be used to construct a SimpleTypeConverter for the content. The
     * SimpleTypeConverter class will be determined using the type of the java field with this
     * annotation.
     */
    String[] format() default {};
    
    /**
     * The text mode. Used to define the method for serializing the text content.
     */
    TextMode textMode() default TextMode.IMPLICIT;

    /**
     * Specifies the converter type to be used for the xml attribute. In the default case the converter type is
     * determined using the type of the java field with this annotation.
     */
    Class converterType() default NoConverterType.class;

    /**
     * In case of a simple type list this annotation parameter provides details about the list items.
     */
    SimpleListItem listItem() default @SimpleListItem();

    /**
     * True, if a value is required; false otherwise.
     */
    boolean required() default false;

    /**
     * Specifies the validator type to be used. In the default case the validator type is determined using the type
     * of the java field with this annotation.
     */
    Class validatorType() default NoValidatorType.class;

    /**
     * The constraints to validate. Each constraint is a String of the form 'name=value' where name is the name of
     * the constraint and value is its value. The allowed set of constraints depend on the validator type. 
     */
    String[] constraints() default {};    
}