org.jboss.shrinkwrap.descriptor.api.webcommon31.WebResourceCollectionType 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.webcommon31; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.webcommon.*;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.*;
import org.jboss.shrinkwrap.descriptor.api.jsp.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.JavaeeWebResourceCollectionCommonType;
/**
 * This interface defines the contract for the  web-resource-collectionType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface WebResourceCollectionType extends Child, 
    JavaeeWebResourceCollectionCommonType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebResourceCollectionType ElementName: xsd:token ElementType : web-resource-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the web-resource-name element
    * @param webResourceName the value for the element web-resource-name 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType webResourceName(String webResourceName);

   /**
    * Returns the web-resource-name element
    * @return the node defined for the element web-resource-name 
    */
   public String getWebResourceName();

   /**
    * Removes the web-resource-name element 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType removeWebResourceName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebResourceCollectionType ElementName: xsd:string ElementType : description
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing description elements, 
    * a new description element 
    * @param values list of description objects 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType description(String ... values);

   /**
    * Returns all description elements
    * @return list of description 
    */
   public List getAllDescription();

   /**
    * Removes the description element 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType removeAllDescription();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebResourceCollectionType ElementName: xsd:string ElementType : url-pattern
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing url-pattern elements, 
    * a new url-pattern element 
    * @param values list of url-pattern objects 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType urlPattern(String ... values);

   /**
    * Returns all url-pattern elements
    * @return list of url-pattern 
    */
   public List getAllUrlPattern();

   /**
    * Removes the url-pattern element 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType removeAllUrlPattern();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebResourceCollectionType ElementName: xsd:token ElementType : http-method
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing http-method elements, 
    * a new http-method element 
    * @param values list of http-method objects 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType httpMethod(String ... values);

   /**
    * Returns all http-method elements
    * @return list of http-method 
    */
   public List getAllHttpMethod();

   /**
    * Removes the http-method element 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType removeAllHttpMethod();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebResourceCollectionType ElementName: xsd:token ElementType : http-method-omission
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing http-method-omission elements, 
    * a new http-method-omission element 
    * @param values list of http-method-omission objects 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType httpMethodOmission(String ... values);

   /**
    * Returns all http-method-omission elements
    * @return list of http-method-omission 
    */
   public List getAllHttpMethodOmission();

   /**
    * Removes the http-method-omission element 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType removeAllHttpMethodOmission();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: WebResourceCollectionType ElementName: xsd:ID ElementType : id
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Returns the id attribute
    * @return the value defined for the attribute id 
    */
   public String getId();

   /**
    * Removes the id attribute 
    * @return the current instance of WebResourceCollectionType 
    */
   public WebResourceCollectionType removeId();
}