Top Description Methods
jakarta.resource.spi

public @Interface ConfigProperty

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:FIELD, METHOD
Imports
java.lang.annotation.Target, .Documented, .Retention

Designates a JavaBean property as a configuration property
Since
1.6

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the configuration property is confidential
confidential
()

Indicates that the configuration property is confidential and recommends application server's configuration tools to use special visual aids for editing them.

public String

Returns:

default value
defaultValue
()

Inferred by the container for field based annotations if possible.

public String[]

Returns:

property description
description
()

Describes the configuration property.

public boolean

Returns:

true if configuration tools must ignore considering this Property during auto-discovery of Configuration properties
ignore
()

Indicates that the configuration tools must ignore considering this Property during auto-discovery of Configuration properties.

public boolean

Returns:

true if the configuration property supports dynamic updates
supportsDynamicUpdates
()

Indicates that the configuration property supports dynamic updates to its value during the lifetime of the JavaBean

public Class<T>

Returns:

property type
type
()

Inferred by the container if unspecified.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

confidentialback to summary
public boolean confidential()

Indicates that the configuration property is confidential and recommends application server's configuration tools to use special visual aids for editing them.

Returns:boolean

true if the configuration property is confidential

defaultValueback to summary
public String defaultValue()

Inferred by the container for field based annotations if possible.

Returns:String

default value

descriptionback to summary
public String[] description()

Describes the configuration property.

Returns:String[]

property description

ignoreback to summary
public boolean ignore()

Indicates that the configuration tools must ignore considering this Property during auto-discovery of Configuration properties.

Returns:boolean

true if configuration tools must ignore considering this Property during auto-discovery of Configuration properties

supportsDynamicUpdatesback to summary
public boolean supportsDynamicUpdates()

Indicates that the configuration property supports dynamic updates to its value during the lifetime of the JavaBean

Returns:boolean

true if the configuration property supports dynamic updates

typeback to summary
public Class<T> type()

Inferred by the container if unspecified.

Returns:Class<T>

property type