org.glassfish.config.support
Annotation Type Delete

@Contract
@Retention(value=RUNTIME)
@Target(value=METHOD)
@InhabitantAnnotation(value="default")
public @interface Delete

Delete command annotation A method annotated with the Delete annotation will generate a generic implementation of a delete administrative command responsible for delete instances of the type as referenced by the annotated method. The deleted type is determine by the annotated method which must follow one of the two following patterns : List getXs(); or void setX(X x); X is the type of instance that will be deleted, the name of the method is actually immaterial. So for example, the following

Author:
  
Jerome Dochez







Required Element Summary




 I18n
i18n



          Returns the i18n key that will be used to look up a localized string in the annotated
 type module.



 String
value



          Name of the command that will be used to register this generic command implementation under.


 


Optional Element Summary




 ExecuteOn
cluster



          Returns the desired behaviors in a clustered environment.



 Class<? extends DeletionDecorator>
decorator



          Returns a decorator type that should be looked up and called when a
 configuration element of the annotated type is deleted.



 Class<? extends CrudResolver>
resolver



          Returns the instance of the configured object that should be deleted.


 





Element Detail



value
@Index
public abstract String value

Name of the command that will be used to register this generic command implementation under.






Returns:
the command name as the user types it.




i18n
public abstract I18n i18n

Returns the i18n key that will be used to look up a localized string in the annotated
 type module.






Returns:
the key to look up localized description for the command.


resolver
public abstract Class<? extends CrudResolver> resolver

Returns the instance of the configured object that should be deleted.
 The implementation of that interface can use the command parameters
 to make a determination about which instance should be used.






Returns:
the instance targeted for deletion.

Default:
org.glassfish.config.support.CrudResolver.DefaultResolver.class





decorator
public abstract Class<? extends DeletionDecorator> decorator

Returns a decorator type that should be looked up and called when a
 configuration element of the annotated type is deleted.






Returns:
a deletion decorator for the annotated type

Default:
org.glassfish.config.support.DeletionDecorator.NoDecoration.class





cluster
public abstract ExecuteOn cluster

Returns the desired behaviors in a clustered environment. By default, using all the
 ExecuteOn default values






Returns:
the cluster information

Default:
@org.glassfish.api.admin.ExecuteOn