org.jboss.managed.api.annotation
Annotation Type ManagementProperty


@Target(value=METHOD)
@Retention(value=RUNTIME)
@Inherited
public @interface ManagementProperty

ManagementProperty annotation for describing a ManagedProperty. Additional annotations that can be used on a property to control the behavior of the property include: ConstraintsPopulatorFactory Masked MetaMapping

Version:
$Revision: 87524 $
Author:
Adrian Brock, Scott.Stark@jboss.org

Optional Element Summary
 ActivationPolicy activationPolicy
          The policy for updating property values
 String[] adminViews
          Strings describing free form association to admin views (Ports, Networks, ...}
 String defaultValue
          A string representation of the property default value if not empty
 String description
          The description
 boolean ignored
          Whether to ignore this property
 boolean includeInTemplate
          Whether this property should be included in a deployment template
 boolean managed
          Whether to create a managed object for the property
 boolean mandatory
          Whether this property is mandatory
 String mappedName
          The internal name of the property as it relates to metadata
 String name
          The external name of the property.
 boolean readOnly
          Whether this property is read only
 ViewUse[] use
          The views this property should be used in
 

description

public abstract String description
The description

Default:
"%Generated%"

name

public abstract String name
The external name of the property. If undefined its taken from the property the annotation is on.

Default:
""

mappedName

public abstract String mappedName
The internal name of the property as it relates to metadata

Default:
""

mandatory

public abstract boolean mandatory
Whether this property is mandatory

Default:
false

readOnly

public abstract boolean readOnly
Whether this property is read only

Default:
false

managed

public abstract boolean managed
Whether to create a managed object for the property

Default:
false

ignored

public abstract boolean ignored
Whether to ignore this property

Default:
false

includeInTemplate

public abstract boolean includeInTemplate
Whether this property should be included in a deployment template

Default:
false

defaultValue

public abstract String defaultValue
A string representation of the property default value if not empty

Default:
""

use

public abstract ViewUse[] use
The views this property should be used in

Default:
org.jboss.managed.api.annotation.ViewUse.CONFIGURATION

activationPolicy

public abstract ActivationPolicy activationPolicy
The policy for updating property values

Default:
org.jboss.managed.api.annotation.ActivationPolicy.IMMEDIATE

adminViews

public abstract String[] adminViews
Strings describing free form association to admin views (Ports, Networks, ...}

Default:
{}


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.