com.opensymphony.xwork2.util.KeyProperty 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 KeyProperty for type conversion.
 * 
 *
 * 
 Annotation usage:
 *
 * 
 * 
The KeyProperty annotation must be applied at field or method level.
 * 
This annotation should be used with Generic types, if the key property of the key element needs to be specified.
 * 
 * 
 Annotation parameters:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Parameter Required Default Description
value no id The key property value.
 * 
 *
 *  Example code:
 * 
 * 
 * // The key property for User objects within the users collection is the userName attribute.
 * @KeyProperty( value = "userName" )
 * protected List users = null;
 * 
 * 
 *
 * @author Patrick Lightbody
 * @author Rainer Hermanns
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface KeyProperty {

    /**
     * The KeyProperty value.
     * Defaults to the id attribute. 
     */
    String value() default "id";
}