com.opensymphony.xwork2.conversion.annotations.Conversion Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 com.opensymphony.xwork2.conversion.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* A marker annotation for type conversions at Type level.
*
*
*
* Annotation usage:
*
*
*
* The Conversion annotation must be applied at Type level.
*
*
* Annotation parameters:
*
*
*
*
*
* Parameter
* Required
* Default
* Description
*
*
*
*
* conversion
* no
*
* used for Type Conversions applied at Type level.
*
*
*
*
*
* Example code:
*
*
*
* @Conversion(
* conversions = {
* // key must be the name of a property for which converter should be used
* @TypeConversion(key = "date", converter = "org.demo.converter.DateConverter")
* }
* )
* public class ConversionAction implements Action {
*
* private Date date;
*
* public setDate(Date date) {
* this.date = date;
* }
*
* public Date getDate() {
* return date;
* }
*
* }
*
*
*
*
* @author Rainer Hermanns
* @version $Id$
*/
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Conversion {
/**
* Allow Type Conversions being applied at Type level.
*
* @return type conversion
*/
TypeConversion[] conversions() default {};
}