com.opensymphony.xwork2.util.Key Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwork Show documentation

XWork is an command-pattern framework that is used to power WebWork as well as other applications. XWork provides an Inversion of Control container, a powerful expression language, data type conversion, validation, and pluggable configuration.

The newest version!

/*
 * Copyright (c) 2002-2006 by OpenSymphony
 * All rights reserved.
 */

package com.opensymphony.xwork2.util;

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

/**
 * 
 * Sets the Key for type conversion.
 * 
 *
 * 
 Annotation usage:
 *
 * 
 * 
The Key annotation must be applied at field or method level.
 * 
 * 
 Annotation parameters:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Parameter Required Default Description
value no java.lang.Object.class The key property value.
 * 
 *
 *  Example code:
 * 
 * 
 * // The key property for User objects within the users collection is the userName attribute.
 * @Key( value = java.lang.Long.class )
 * private Map userMap;
 * 
 * 
 *
 * @author Rainer Hermanns
 * @version $Id: Key.java 1833 2008-06-21 09:29:39Z rainerh $
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface Key {

    /**
     * The Key value.
     * Defaults to java.lang.Object.class.
     */
    Class value() default java.lang.Object.class;
}