net.sf.jsefa.xml.annotation.ListItem Maven / Gradle / Ivy
/*
* 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 net.sf.jsefa.common.annotation.NoClass;
import net.sf.jsefa.common.annotation.NoConverterType;
import net.sf.jsefa.common.annotation.NoValidatorType;
import net.sf.jsefa.common.converter.SimpleTypeConverter;
import net.sf.jsefa.common.validator.Validator;
import net.sf.jsefa.xml.lowlevel.TextMode;
/**
* Annotation describing the object type and element name of a list item.
*
* @see XmlElementList
* @author Norman Lahme-Huetig
* @author Matthias Derer
*
*/
public @interface ListItem {
/**
* The name of the element this annotation describes. It has the following format:
* [prefix:]localname
*/
String name();
/**
* The name of the data type this ListItem describes. If not set, it must be determinable from
* the given object type or from the generic parameter argument of the annotated field.
*
* It should be explicitly set if the type mapping should not be created from the annotations given in the
* class objectType. This is useful when mixing explicit type mapping creation with annotation
* based type mapping creation.
*/
String dataTypeName() default "";
/**
* The type of the object this ListItem describes. From this the data type must be determinable
* if it is not explicity given. If the object type is not set or determinable from the generic parameter
* argument of the annotated field, the data type name must be given explicitly.
*
* The object type will be ignored if the data type name is given explicitly.
*/
Class objectType() default NoClass.class;
/**
* The format to be used to construct a SimpleTypeConverter for the xml element which must have
* a simple data type (no children, no data holding attributes). 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 element which must have a simple data type (no children,
* no data holding attributes). In the default case the converter type is determined using the type of the list
* item.
*/
Class converterType() default NoConverterType.class;
/**
* 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 {};
}