org.jboss.shrinkwrap.descriptor.api.beans10.BeansDescriptor Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
package org.jboss.shrinkwrap.descriptor.api.beans10; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.beans10.Interceptors;
import org.jboss.shrinkwrap.descriptor.api.beans10.Decorators;
import org.jboss.shrinkwrap.descriptor.api.beans10.Alternatives;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;

import org.jboss.shrinkwrap.descriptor.api.beans.*;
/** 
 *  
 * This deployment descriptor provides the functionalities as described in the  specification
 * 
 
 * Example:
 *  
 *  
 *     BeansDescriptor descriptor = Descriptors.create(BeansDescriptor.class);
 *  
 *
 *
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface BeansDescriptor extends Descriptor, DescriptorNamespace, 
    BeansCommonDescriptor {

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeansDescriptor ElementName: javaee:interceptors ElementType : interceptors
   // MaxOccurs: -  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new interceptors element with the given value will be created.
    * Otherwise, the existing interceptors element will be returned.
    * @return  a new or existing instance of Interceptors 
    */
   public Interceptors getOrCreateInterceptors();

   /**
    * Removes the interceptors element 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor removeInterceptors();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeansDescriptor ElementName: javaee:decorators ElementType : decorators
   // MaxOccurs: -  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new decorators element with the given value will be created.
    * Otherwise, the existing decorators element will be returned.
    * @return  a new or existing instance of Decorators 
    */
   public Decorators getOrCreateDecorators();

   /**
    * Removes the decorators element 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor removeDecorators();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeansDescriptor ElementName: javaee:alternatives ElementType : alternatives
   // MaxOccurs: -  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new alternatives element with the given value will be created.
    * Otherwise, the existing alternatives element will be returned.
    * @return  a new or existing instance of Alternatives 
    */
   public Alternatives getOrCreateAlternatives();

   /**
    * Removes the alternatives element 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor removeAlternatives();
}