org.exoplatform.container.management

Class MetaDataBuilder

java.lang.Object

org.exoplatform.container.management.MetaDataBuilder

public class MetaDataBuilder
extends Object

A class that build the management view meta data of a specified class.

The following rules do apply to the class from which meta data are constructed:

• The class must be annotated by Managed
• The class may be annoated by ManagedDescription
• Any property described by its getter and/or setter getter annotated by Managed is exposed as an attribute
• Any property providing an annotated getter is readable
• Any property providing an annotated setter is writable
• Any getter/setter annotated by ManagedName redefines the attribute name
• Any getter/setter annotated by ManagedDescription defines the attribute description
• When corresponding getter/setter redefines the attribute name, the value must be the same otherwhise an exception is thrown at built time
• Any method annotated by Managed is exposed as a management operation
• Any method annotated by ManagedDescription defines the operation description
• Any non setter/getter method annotated by ManagedName causes a built time exception
• Any method argument annotated by ManagedName defines the management name of the corresponding operation parameter
• Any method argument annotated by ManagedDescription defines the management description of the corresponding operation parameter

Version:

$Revision$

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
MetaDataBuilder(Class clazz) Create a new builder.

Method Summary

Methods

Modifier and Type	Method and Description
ManagedTypeMetaData	build() Build the info.
boolean	isBuildable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaDataBuilder

public MetaDataBuilder(Class clazz)
                throws IllegalArgumentException

Create a new builder.

Parameters:

clazz - the clazz

Throws:

IllegalArgumentException - if the class is null or is not annotated by Managed

Method Detail

isBuildable

public boolean isBuildable()

build

public ManagedTypeMetaData build()
                          throws IllegalStateException

Build the info.

Returns:

returns the info

Throws:

IllegalStateException - raised by any build time issue