org.jboss.shrinkwrap.descriptor.api.webcommon30.ServletType 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.javaee6.ParamValueType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.RunAsType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.SecurityRoleRefType;
import org.jboss.shrinkwrap.descriptor.api.webcommon30.MultipartConfigType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.IconType;
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.JavaeeServletCommonType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.ParamValueType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.RunAsType;
import org.jboss.shrinkwrap.descriptor.api.javaee6.SecurityRoleRefType;/**
* This interface defines the contract for the servletType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface ServletType extends Child,
JavaeeServletCommonType,
ParamValueType>,
RunAsType>,
SecurityRoleRefType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType 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 ServletType
*/
public ServletType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of ServletType
*/
public ServletType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: xsd:token ElementType : display-name
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing display-name elements,
* a new display-name element
* @param values list of display-name objects
* @return the current instance of ServletType
*/
public ServletType displayName(String ... values);
/**
* Returns all display-name elements
* @return list of display-name
*/
public List getAllDisplayName();
/**
* Removes the display-name element
* @return the current instance of ServletType
*/
public ServletType removeAllDisplayName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:iconType ElementType : icon
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new icon element will be created and returned.
* Otherwise, the first existing icon element will be returned.
* @return the instance defined for the element icon
*/
public IconType> getOrCreateIcon();
/**
* Creates a new icon element
* @return the new created instance of IconType>
*/
public IconType> createIcon();
/**
* Returns all icon elements
* @return list of icon
*/
public List>> getAllIcon();
/**
* Removes all icon elements
* @return the current instance of IconType>
*/
public ServletType removeAllIcon();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType 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 ServletType
*/
public ServletType 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 ServletType
*/
public ServletType removeServletName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: xsd:token ElementType : servlet-class
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the servlet-class element
* @param servletClass the value for the element servlet-class
* @return the current instance of ServletType
*/
public ServletType servletClass(String servletClass);
/**
* Returns the servlet-class element
* @return the node defined for the element servlet-class
*/
public String getServletClass();
/**
* Removes the servlet-class element
* @return the current instance of ServletType
*/
public ServletType removeServletClass();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:pathType ElementType : jsp-file
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the jsp-file element
* @param jspFile the value for the element jsp-file
* @return the current instance of ServletType
*/
public ServletType jspFile(String jspFile);
/**
* Returns the jsp-file element
* @return the node defined for the element jsp-file
*/
public String getJspFile();
/**
* Removes the jsp-file element
* @return the current instance of ServletType
*/
public ServletType removeJspFile();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:param-valueType ElementType : init-param
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new init-param element will be created and returned.
* Otherwise, the first existing init-param element will be returned.
* @return the instance defined for the element init-param
*/
public ParamValueType> getOrCreateInitParam();
/**
* Creates a new init-param element
* @return the new created instance of ParamValueType>
*/
public ParamValueType> createInitParam();
/**
* Returns all init-param elements
* @return list of init-param
*/
public List>> getAllInitParam();
/**
* Removes all init-param elements
* @return the current instance of ParamValueType>
*/
public ServletType removeAllInitParam();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: xsd:integer ElementType : load-on-startup
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the load-on-startup element
* @param loadOnStartup the value for the element load-on-startup
* @return the current instance of ServletType
*/
public ServletType loadOnStartup(Integer loadOnStartup);
/**
* Returns the load-on-startup element
* @return the node defined for the element load-on-startup
*/
public Integer getLoadOnStartup();
/**
* Removes the load-on-startup element
* @return the current instance of ServletType
*/
public ServletType removeLoadOnStartup();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:xsdBooleanType ElementType : enabled
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the enabled element
* @param enabled the value for the element enabled
* @return the current instance of ServletType
*/
public ServletType enabled(Boolean enabled);
/**
* Returns the enabled element
* @return the node defined for the element enabled
*/
public Boolean isEnabled();
/**
* Removes the enabled element
* @return the current instance of ServletType
*/
public ServletType removeEnabled();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:xsdBooleanType ElementType : async-supported
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the async-supported element
* @param asyncSupported the value for the element async-supported
* @return the current instance of ServletType
*/
public ServletType asyncSupported(Boolean asyncSupported);
/**
* Returns the async-supported element
* @return the node defined for the element async-supported
*/
public Boolean isAsyncSupported();
/**
* Removes the async-supported element
* @return the current instance of ServletType
*/
public ServletType removeAsyncSupported();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:run-asType ElementType : run-as
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new run-as element with the given value will be created.
* Otherwise, the existing run-as element will be returned.
* @return a new or existing instance of RunAsType>
*/
public RunAsType> getOrCreateRunAs();
/**
* Removes the run-as element
* @return the current instance of ServletType
*/
public ServletType removeRunAs();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:security-role-refType ElementType : security-role-ref
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new security-role-ref element will be created and returned.
* Otherwise, the first existing security-role-ref element will be returned.
* @return the instance defined for the element security-role-ref
*/
public SecurityRoleRefType> getOrCreateSecurityRoleRef();
/**
* Creates a new security-role-ref element
* @return the new created instance of SecurityRoleRefType>
*/
public SecurityRoleRefType> createSecurityRoleRef();
/**
* Returns all security-role-ref elements
* @return list of security-role-ref
*/
public List>> getAllSecurityRoleRef();
/**
* Removes all security-role-ref elements
* @return the current instance of SecurityRoleRefType>
*/
public ServletType removeAllSecurityRoleRef();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType ElementName: javaee:multipart-configType ElementType : multipart-config
// MaxOccurs: -1 isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new multipart-config element with the given value will be created.
* Otherwise, the existing multipart-config element will be returned.
* @return a new or existing instance of MultipartConfigType>
*/
public MultipartConfigType> getOrCreateMultipartConfig();
/**
* Removes the multipart-config element
* @return the current instance of ServletType
*/
public ServletType removeMultipartConfig();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ServletType 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 ServletType
*/
public ServletType 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 ServletType
*/
public ServletType removeId();
}