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

package org.jboss.shrinkwrap.descriptor.api.beans11; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.beans11.Interceptors;
import org.jboss.shrinkwrap.descriptor.api.beans11.Decorators;
import org.jboss.shrinkwrap.descriptor.api.beans11.Alternatives;
import org.jboss.shrinkwrap.descriptor.api.beans11.Scan;
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
 */
public interface BeansDescriptor extends Descriptor, DescriptorNamespace, 
    BeansCommonDescriptor {

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

   /**
    * If not already created, a new interceptors element will be created and returned.
    * Otherwise, the first existing interceptors element will be returned.
    * @return the instance defined for the element interceptors 
    */
   public Interceptors getOrCreateInterceptors();

   /**
    * Creates a new interceptors element 
    * @return the new created instance of Interceptors 
    */
   public Interceptors createInterceptors();

   /**
    * Returns all interceptors elements
    * @return list of interceptors 
    */
   public List> getAllInterceptors();

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

   /**
    * If not already created, a new decorators element will be created and returned.
    * Otherwise, the first existing decorators element will be returned.
    * @return the instance defined for the element decorators 
    */
   public Decorators getOrCreateDecorators();

   /**
    * Creates a new decorators element 
    * @return the new created instance of Decorators 
    */
   public Decorators createDecorators();

   /**
    * Returns all decorators elements
    * @return list of decorators 
    */
   public List> getAllDecorators();

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

   /**
    * If not already created, a new alternatives element will be created and returned.
    * Otherwise, the first existing alternatives element will be returned.
    * @return the instance defined for the element alternatives 
    */
   public Alternatives getOrCreateAlternatives();

   /**
    * Creates a new alternatives element 
    * @return the new created instance of Alternatives 
    */
   public Alternatives createAlternatives();

   /**
    * Returns all alternatives elements
    * @return list of alternatives 
    */
   public List> getAllAlternatives();

   /**
    * Removes all alternatives elements 
    * @return the current instance of Alternatives 
    */
   public BeansDescriptor removeAllAlternatives();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeansDescriptor ElementName: javaee:scan ElementType : scan
   // MaxOccurs: -unbounded  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new scan element will be created and returned.
    * Otherwise, the first existing scan element will be returned.
    * @return the instance defined for the element scan 
    */
   public Scan getOrCreateScan();

   /**
    * Creates a new scan element 
    * @return the new created instance of Scan 
    */
   public Scan createScan();

   /**
    * Returns all scan elements
    * @return list of scan 
    */
   public List> getAllScan();

   /**
    * Removes all scan elements 
    * @return the current instance of Scan 
    */
   public BeansDescriptor removeAllScan();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeansDescriptor ElementName: xsd:string ElementType : version
   // MaxOccurs: -  isGeneric: false   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the version attribute
    * @param version the value for the attribute version 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor version(String version);

   /**
    * Returns the version attribute
    * @return the value defined for the attribute version 
    */
   public String getVersion();

   /**
    * Removes the version attribute 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor removeVersion();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: BeansDescriptor ElementName: xsd:string ElementType : bean-discovery-mode
   // MaxOccurs: -  isGeneric: false   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the bean-discovery-mode attribute
    * @param beanDiscoveryMode the value for the attribute bean-discovery-mode 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor beanDiscoveryMode(String beanDiscoveryMode);

   /**
    * Returns the bean-discovery-mode attribute
    * @return the value defined for the attribute bean-discovery-mode 
    */
   public String getBeanDiscoveryMode();

   /**
    * Removes the bean-discovery-mode attribute 
    * @return the current instance of BeansDescriptor 
    */
   public BeansDescriptor removeBeanDiscoveryMode();
}