com.opensymphony.xwork2.util

## Annotation Type KeyProperty

-     @Retention(value=RUNTIME)
       @Target(value={FIELD,METHOD})
      public @interface KeyProperty

  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<User> users = null;

  Author:
    Patrick Lightbody, Rainer Hermanns

- - ### Optional Element Summary

    Optional Elements
    Modifier and Type | Optional Element and Description
    --- | ---
    `String` | `value`

- - ### Element Detail

    - #### value

          public abstract String value

      Returns:
        The KeyProperty value. Defaults to the `id` attribute.
      Default:
        "id"

Copyright © 2000–2025 Apache Software Foundation. All rights reserved.