org.jboss.shrinkwrap.descriptor.api.webcommon30.FilterMappingType 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.webcommon30; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.webcommon30.DispatcherType;
import org.jboss.shrinkwrap.descriptor.api.webcommon.*;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
import org.jboss.shrinkwrap.descriptor.api.jsp.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.JavaeeFilterMappingCommonType;
/**
 * This interface defines the contract for the  filter-mappingType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface FilterMappingType extends Child, 
    JavaeeFilterMappingCommonType> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType ElementName: javaee:nonEmptyStringType ElementType : filter-name
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the filter-name element
    * @param filterName the value for the element filter-name 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType filterName(String filterName);

   /**
    * Returns the filter-name element
    * @return the node defined for the element filter-name 
    */
   public String getFilterName();

   /**
    * Removes the filter-name element 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType removeFilterName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType 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 FilterMappingType 
    */
   public FilterMappingType 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 FilterMappingType 
    */
   public FilterMappingType removeAllUrlPattern();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType ElementName: javaee:nonEmptyStringType ElementType : servlet-name
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all String objects representing servlet-name elements, 
    * a new servlet-name element 
    * @param values list of servlet-name objects 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType servletName(String ... values);

   /**
    * Returns all servlet-name elements
    * @return list of servlet-name 
    */
   public List getAllServletName();

   /**
    * Removes the servlet-name element 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType removeAllServletName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType ElementName: javaee:dispatcherType ElementType : dispatcher
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Creates for all javaee:dispatcherType objects representing dispatcher elements, 
    * a new dispatcher element 
    * @param values list of dispatcher objects 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType dispatcher(DispatcherType ... values);

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

   /**
    * Returns all dispatcher elements
    * @return list of dispatcher 
    */
   public List getAllDispatcher();

   /**
    * Removes the dispatcher element 
    * @return the current instance of FilterMappingType 
    */
   public FilterMappingType removeAllDispatcher();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FilterMappingType 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 FilterMappingType 
    */
   public FilterMappingType 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 FilterMappingType 
    */
   public FilterMappingType removeId();
}