Top Description Methods
org.jboss.logging.annotations

public @Interface Field

extends Annotation
Annotations
@Retention:CLASS
@Target:PARAMETER, METHOD
@Repeatable:Fields
@Documented
Static Imports
java.lang.annotation.ElementType.METHOD, .ElementType.PARAMETER, .RetentionPolicy.CLASS
Indicate that a method parameter value should be applied to a field on the resultant exception object.

If this annotation is placed on a method the name attribute becomes a required parameter and one default attribute needs to be set. The value of the default attribute is used to set the filed on the resultant exception object.

Authors
David M. Lloyd, James R. Perkins

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the default value to use
booleanValue()

The default boolean value if this annotation is used on a method.

public byte

Returns:

the default value to use
byteValue()

The default boolean value if this annotation is used on a method.

public char

Returns:

the default value to use
charValue()

The default byte value if this annotation is used on a method.

public Class<?>

Returns:

the default value to use
classValue()

The default Class value if this annotation is used on a method.

public double

Returns:

the default value to use
doubleValue()

The default double value if this annotation is used on a method.

public float

Returns:

the default value to use
floatValue()

The default float value if this annotation is used on a method.

public int

Returns:

the default value to use
intValue()

The default int value if this annotation is used on a method.

public long

Returns:

the default value to use
longValue()

The default long value if this annotation is used on a method.

public String

Returns:

the field name
name()

The field name.

public short

Returns:

the default value to use
shortValue()

The default short value if this annotation is used on a method.

public String

Returns:

the default value to use
stringValue()

The default String value if this annotation is used on a method.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

booleanValueback to summary
public boolean booleanValue()

The default boolean value if this annotation is used on a method.

Returns:boolean

the default value to use

byteValueback to summary
public byte byteValue()

The default boolean value if this annotation is used on a method.

Returns:byte

the default value to use

charValueback to summary
public char charValue()

The default byte value if this annotation is used on a method.

Returns:char

the default value to use

classValueback to summary
public Class<?> classValue()

The default Class value if this annotation is used on a method.

Returns:Class<?>

the default value to use

doubleValueback to summary
public double doubleValue()

The default double value if this annotation is used on a method.

Returns:double

the default value to use

floatValueback to summary
public float floatValue()

The default float value if this annotation is used on a method.

Returns:float

the default value to use

intValueback to summary
public int intValue()

The default int value if this annotation is used on a method.

Returns:int

the default value to use

longValueback to summary
public long longValue()

The default long value if this annotation is used on a method.

Returns:long

the default value to use

nameback to summary
public String name()

The field name. If not specified, the parameter name is assumed to be the field name.

This becomes a required attrubyte if this annotation is present on a method.

Returns:String

the field name

shortValueback to summary
public short shortValue()

The default short value if this annotation is used on a method.

Returns:short

the default value to use

stringValueback to summary
public String stringValue()

The default String value if this annotation is used on a method.

Returns:String

the default value to use