net.sf.jsefa.xml.annotation.XmlElement Maven / Gradle / Ivy
Show all versions of jsefa-android Show documentation
/*
* 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 a xml element during XML serialization
* and deserialization.
*
* @author Norman Lahme-Huetig
* @author Matthias Derer
*
*/
@Retention(RUNTIME)
@Target({FIELD})
public @interface XmlElement {
/**
* The name of the element this annotation describes. It has the following format:
* [prefix:]localname
*/
String name() default "";
/**
* The type of default name if no explicit name is given.
*/
DefaultName defaultName() default DefaultName.FIELD_NAME;
/**
* The name of the data type of the element this annotation describes. If not set, it must be determinable from
* the type of the annotated field.
*
* It should be explicitly set if the type mapping should not be created from the annotations given in the
* class of the annotated field. This is useful when mixing explicit type mapping creation with annotation
* based type mapping creation.
*/
String dataTypeName() default "";
/**
* The position of the xml element with the following semantic:
*
* If the position of a element A is less than the position of a element B, than element A comes (not
* necessarily directly) before element B.
* All elements with the default position value (-1) will come after all elements with explicitly given
* positions.
*/
int pos() default -1;
/**
* The text mode. Used to define the method for serializing the text content.
*/
TextMode textMode() default TextMode.IMPLICIT;
/**
* 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 {};
/**
* 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 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 {};
}