org.jboss.shrinkwrap.descriptor.api.beans11.Exclude 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.beans11; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.beans11.IfClassAvailable;
import org.jboss.shrinkwrap.descriptor.api.beans11.IfClassNotAvailable;
import org.jboss.shrinkwrap.descriptor.api.beans11.IfSystemProperty;
import org.jboss.shrinkwrap.descriptor.api.beans.*;
import org.jboss.shrinkwrap.descriptor.api.beans.JavaeeExcludeCommType;

import org.jboss.shrinkwrap.descriptor.api.beans11.IfClassAvailable;
import org.jboss.shrinkwrap.descriptor.api.beans11.IfClassNotAvailable;
import org.jboss.shrinkwrap.descriptor.api.beans11.IfSystemProperty;/**
 * This interface defines the contract for the  exclude  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface Exclude extends Child, 
    JavaeeExcludeCommType,
    IfClassAvailable>,
    IfClassNotAvailable>,
    IfSystemProperty>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Exclude ElementName: javaee:if-class-available ElementType : if-class-available
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new if-class-available element will be created and returned.
    * Otherwise, the first existing if-class-available element will be returned.
    * @return the instance defined for the element if-class-available 
    */
   public IfClassAvailable> getOrCreateIfClassAvailable();

   /**
    * Creates a new if-class-available element 
    * @return the new created instance of IfClassAvailable> 
    */
   public IfClassAvailable> createIfClassAvailable();

   /**
    * Returns all if-class-available elements
    * @return list of if-class-available 
    */
   public List>> getAllIfClassAvailable();

   /**
    * Removes all if-class-available elements 
    * @return the current instance of IfClassAvailable> 
    */
   public Exclude removeAllIfClassAvailable();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Exclude ElementName: javaee:if-class-not-available ElementType : if-class-not-available
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new if-class-not-available element will be created and returned.
    * Otherwise, the first existing if-class-not-available element will be returned.
    * @return the instance defined for the element if-class-not-available 
    */
   public IfClassNotAvailable> getOrCreateIfClassNotAvailable();

   /**
    * Creates a new if-class-not-available element 
    * @return the new created instance of IfClassNotAvailable> 
    */
   public IfClassNotAvailable> createIfClassNotAvailable();

   /**
    * Returns all if-class-not-available elements
    * @return list of if-class-not-available 
    */
   public List>> getAllIfClassNotAvailable();

   /**
    * Removes all if-class-not-available elements 
    * @return the current instance of IfClassNotAvailable> 
    */
   public Exclude removeAllIfClassNotAvailable();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Exclude ElementName: javaee:if-system-property ElementType : if-system-property
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new if-system-property element will be created and returned.
    * Otherwise, the first existing if-system-property element will be returned.
    * @return the instance defined for the element if-system-property 
    */
   public IfSystemProperty> getOrCreateIfSystemProperty();

   /**
    * Creates a new if-system-property element 
    * @return the new created instance of IfSystemProperty> 
    */
   public IfSystemProperty> createIfSystemProperty();

   /**
    * Returns all if-system-property elements
    * @return list of if-system-property 
    */
   public List>> getAllIfSystemProperty();

   /**
    * Removes all if-system-property elements 
    * @return the current instance of IfSystemProperty> 
    */
   public Exclude removeAllIfSystemProperty();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: Exclude ElementName: xsd:string ElementType : name
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Returns the name attribute
    * @return the value defined for the attribute name 
    */
   public String getName();

   /**
    * Removes the name attribute 
    * @return the current instance of Exclude 
    */
   public Exclude removeName();
}