org.jboss.shrinkwrap.descriptor.api.webcommon30.ServletMappingType Maven / Gradle / Ivy

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.webcommon.*;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
import org.jboss.shrinkwrap.descriptor.api.jsp.*;
import org.jboss.shrinkwrap.descriptor.api.webapp.JavaeeServletMappingCommonType;
/**
 * This interface defines the contract for the  servlet-mappingType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface ServletMappingType extends Child, 
    JavaeeServletMappingCommonType> { 

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

   /**
    * Sets the servlet-name element
    * @param servletName the value for the element servlet-name 
    * @return the current instance of ServletMappingType 
    */
   public ServletMappingType servletName(String servletName);

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

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

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

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