org.jboss.shrinkwrap.descriptor.impl.webcommon30
Class ServletTypeImpl<T>

java.lang.Object
  extended by org.jboss.shrinkwrap.descriptor.impl.webcommon30.ServletTypeImpl<T>
All Implemented Interfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>, ServletType<T>

public class ServletTypeImpl<T>
extends java.lang.Object
implements org.jboss.shrinkwrap.descriptor.api.Child<T>, ServletType<T>

This class implements the servletType xsd type

Original Documentation:



The servletType is used to declare a servlet.
It contains the declarative data of a
servlet. If a jsp-file is specified and the load-on-startup
element is present, then the JSP should be precompiled and
loaded.

Used in: web-app


Since:
Generation date :2011-07-19T22:55:02.759+02:00
Author:
Ralf Battenfeld

Constructor Summary
ServletTypeImpl(T t, java.lang.String nodeName, org.jboss.shrinkwrap.descriptor.spi.Node node)
           
ServletTypeImpl(T t, java.lang.String nodeName, org.jboss.shrinkwrap.descriptor.spi.Node node, org.jboss.shrinkwrap.descriptor.spi.Node childNode)
           
 
Method Summary
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.util.List<java.lang.String> getDisplayNameList()
          Returns all display-name elements
 java.util.List<IconType<ServletType<T>>> getIconList()
          Returns all icon elements
 java.util.List<ParamValueType<ServletType<T>>> getInitParamList()
          Returns all init-param elements
 java.lang.String getJspFile()
          Returns the jsp-file element
 java.lang.Integer getLoadOnStartup()
          Returns the load-on-startup element
 java.util.List<SecurityRoleRefType<ServletType<T>>> getSecurityRoleRefList()
          Returns all security-role-ref elements
 java.lang.String getServletClass()
          Returns the servlet-class element
 java.lang.String getServletName()
          Returns the servlet-name element
 IconType<ServletType<T>> icon()
          Returns the icon element
 ParamValueType<ServletType<T>> initParam()
          Returns the init-param element
 java.lang.Boolean isAsyncSupported()
          Returns the async-supported element
 java.lang.Boolean isEnabled()
          Returns the enabled element
 MultipartConfigType<ServletType<T>> multipartConfig()
          If not already created, a new multipart-config element will be created and returned.
 ServletType<T> removeAllDescription()
          Removes the description element
 ServletType<T> removeAllDisplayName()
          Removes the display-name element
 ServletType<T> removeAllIcon()
          Removes all icon elements
 ServletType<T> removeAllInitParam()
          Removes all init-param elements
 ServletType<T> removeAllSecurityRoleRef()
          Removes all security-role-ref elements
 ServletType<T> removeAsyncSupported()
          Removes the async-supported element
 ServletType<T> removeEnabled()
          Removes the enabled element
 ServletType<T> removeJspFile()
          Removes the jsp-file element
 ServletType<T> removeLoadOnStartup()
          Removes the load-on-startup element
 ServletType<T> removeMultipartConfig()
          Removes the multipart-config element
 ServletType<T> removeRunAs()
          Removes the run-as element
 ServletType<T> removeServletClass()
          Removes the servlet-class element
 ServletType<T> removeServletName()
          Removes the servlet-name element
 RunAsType<ServletType<T>> runAs()
          If not already created, a new run-as element will be created and returned.
 SecurityRoleRefType<ServletType<T>> securityRoleRef()
          Returns the security-role-ref element
 ServletType<T> setAsyncSupported(java.lang.Boolean asyncSupported)
          If not already created, a new async-supported element with the given value will be created.
 ServletType<T> setDescription(java.lang.String description)
          Creates a new description element
 ServletType<T> setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 ServletType<T> setDisplayName(java.lang.String displayName)
          Creates a new display-name element
 ServletType<T> setDisplayNameList(java.lang.String... values)
          Creates for all String objects representing display-name elements, a new display-name element
 ServletType<T> setEnabled(java.lang.Boolean enabled)
          If not already created, a new enabled element with the given value will be created.
 ServletType<T> setJspFile(java.lang.String jspFile)
          If not already created, a new jsp-file element with the given value will be created.
 ServletType<T> setLoadOnStartup(java.lang.Integer loadOnStartup)
          If not already created, a new load-on-startup element with the given value will be created.
 ServletType<T> setServletClass(java.lang.String servletClass)
          If not already created, a new servlet-class element with the given value will be created.
 ServletType<T> setServletName(java.lang.String servletName)
          If not already created, a new servlet-name element with the given value will be created.
 T up()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletTypeImpl

public ServletTypeImpl(T t,
                       java.lang.String nodeName,
                       org.jboss.shrinkwrap.descriptor.spi.Node node)

ServletTypeImpl

public ServletTypeImpl(T t,
                       java.lang.String nodeName,
                       org.jboss.shrinkwrap.descriptor.spi.Node node,
                       org.jboss.shrinkwrap.descriptor.spi.Node childNode)
Method Detail

up

public T up()
Specified by:
up in interface org.jboss.shrinkwrap.descriptor.api.Child<T>

setDescription

public ServletType<T> setDescription(java.lang.String description)
Creates a new description element

Specified by:
setDescription in interface ServletType<T>
Returns:
the current instance of ServletType

setDescriptionList

public ServletType<T> setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements, a new description element

Specified by:
setDescriptionList in interface ServletType<T>
Parameters:
list - of description objects
Returns:
the current instance of ServletType

removeAllDescription

public ServletType<T> removeAllDescription()
Removes the description element

Specified by:
removeAllDescription in interface ServletType<T>
Returns:
the current instance of ServletType

getDescriptionList

public java.util.List<java.lang.String> getDescriptionList()
Returns all description elements

Specified by:
getDescriptionList in interface ServletType<T>
Returns:
list of description

setDisplayName

public ServletType<T> setDisplayName(java.lang.String displayName)
Creates a new display-name element

Specified by:
setDisplayName in interface ServletType<T>
Returns:
the current instance of ServletType

setDisplayNameList

public ServletType<T> setDisplayNameList(java.lang.String... values)
Creates for all String objects representing display-name elements, a new display-name element

Specified by:
setDisplayNameList in interface ServletType<T>
Parameters:
list - of display-name objects
Returns:
the current instance of ServletType

removeAllDisplayName

public ServletType<T> removeAllDisplayName()
Removes the display-name element

Specified by:
removeAllDisplayName in interface ServletType<T>
Returns:
the current instance of ServletType

getDisplayNameList

public java.util.List<java.lang.String> getDisplayNameList()
Returns all display-name elements

Specified by:
getDisplayNameList in interface ServletType<T>
Returns:
list of display-name

removeAllIcon

public ServletType<T> removeAllIcon()
Removes all icon elements

Specified by:
removeAllIcon in interface ServletType<T>
Returns:
the current instance of ServletType

icon

public IconType<ServletType<T>> icon()
Returns the icon element

Specified by:
icon in interface ServletType<T>
Returns:
the node defined for the element icon

getIconList

public java.util.List<IconType<ServletType<T>>> getIconList()
Returns all icon elements

Specified by:
getIconList in interface ServletType<T>
Returns:
list of icon

setServletName

public ServletType<T> setServletName(java.lang.String servletName)
If not already created, a new servlet-name element with the given value will be created. Otherwise, the existing servlet-name element will be updated with the given value.

Specified by:
setServletName in interface ServletType<T>
Returns:
the current instance of ServletType

removeServletName

public ServletType<T> removeServletName()
Removes the servlet-name element

Specified by:
removeServletName in interface ServletType<T>
Returns:
the current instance of ServletType

getServletName

public java.lang.String getServletName()
Returns the servlet-name element

Specified by:
getServletName in interface ServletType<T>
Returns:
the node defined for the element servlet-name

removeAllInitParam

public ServletType<T> removeAllInitParam()
Removes all init-param elements

Specified by:
removeAllInitParam in interface ServletType<T>
Returns:
the current instance of ServletType

initParam

public ParamValueType<ServletType<T>> initParam()
Returns the init-param element

Specified by:
initParam in interface ServletType<T>
Returns:
the node defined for the element init-param

getInitParamList

public java.util.List<ParamValueType<ServletType<T>>> getInitParamList()
Returns all init-param elements

Specified by:
getInitParamList in interface ServletType<T>
Returns:
list of init-param

setLoadOnStartup

public ServletType<T> setLoadOnStartup(java.lang.Integer loadOnStartup)
If not already created, a new load-on-startup element with the given value will be created. Otherwise, the existing load-on-startup element will be updated with the given value.

Specified by:
setLoadOnStartup in interface ServletType<T>
Returns:
the current instance of ServletType

removeLoadOnStartup

public ServletType<T> removeLoadOnStartup()
Removes the load-on-startup element

Specified by:
removeLoadOnStartup in interface ServletType<T>
Returns:
the current instance of ServletType

getLoadOnStartup

public java.lang.Integer getLoadOnStartup()
Returns the load-on-startup element

Specified by:
getLoadOnStartup in interface ServletType<T>
Returns:
the node defined for the element load-on-startup

setEnabled

public ServletType<T> setEnabled(java.lang.Boolean enabled)
If not already created, a new enabled element with the given value will be created. Otherwise, the existing enabled element will be updated with the given value.

Specified by:
setEnabled in interface ServletType<T>
Returns:
the current instance of ServletType

removeEnabled

public ServletType<T> removeEnabled()
Removes the enabled element

Specified by:
removeEnabled in interface ServletType<T>
Returns:
the current instance of ServletType

isEnabled

public java.lang.Boolean isEnabled()
Returns the enabled element

Specified by:
isEnabled in interface ServletType<T>
Returns:
the node defined for the element enabled

setAsyncSupported

public ServletType<T> setAsyncSupported(java.lang.Boolean asyncSupported)
If not already created, a new async-supported element with the given value will be created. Otherwise, the existing async-supported element will be updated with the given value.

Specified by:
setAsyncSupported in interface ServletType<T>
Returns:
the current instance of ServletType

removeAsyncSupported

public ServletType<T> removeAsyncSupported()
Removes the async-supported element

Specified by:
removeAsyncSupported in interface ServletType<T>
Returns:
the current instance of ServletType

isAsyncSupported

public java.lang.Boolean isAsyncSupported()
Returns the async-supported element

Specified by:
isAsyncSupported in interface ServletType<T>
Returns:
the node defined for the element async-supported

removeRunAs

public ServletType<T> removeRunAs()
Removes the run-as element

Specified by:
removeRunAs in interface ServletType<T>
Returns:
the current instance of ServletType

runAs

public RunAsType<ServletType<T>> runAs()
If not already created, a new run-as element will be created and returned. Otherwise, the existing run-as element will be returned.

Specified by:
runAs in interface ServletType<T>
Returns:
the node defined for the element run-as

removeAllSecurityRoleRef

public ServletType<T> removeAllSecurityRoleRef()
Removes all security-role-ref elements

Specified by:
removeAllSecurityRoleRef in interface ServletType<T>
Returns:
the current instance of ServletType

securityRoleRef

public SecurityRoleRefType<ServletType<T>> securityRoleRef()
Returns the security-role-ref element

Specified by:
securityRoleRef in interface ServletType<T>
Returns:
the node defined for the element security-role-ref

getSecurityRoleRefList

public java.util.List<SecurityRoleRefType<ServletType<T>>> getSecurityRoleRefList()
Returns all security-role-ref elements

Specified by:
getSecurityRoleRefList in interface ServletType<T>
Returns:
list of security-role-ref

removeMultipartConfig

public ServletType<T> removeMultipartConfig()
Removes the multipart-config element

Specified by:
removeMultipartConfig in interface ServletType<T>
Returns:
the current instance of ServletType

multipartConfig

public MultipartConfigType<ServletType<T>> multipartConfig()
If not already created, a new multipart-config element will be created and returned. Otherwise, the existing multipart-config element will be returned.

Specified by:
multipartConfig in interface ServletType<T>
Returns:
the node defined for the element multipart-config

setServletClass

public ServletType<T> setServletClass(java.lang.String servletClass)
If not already created, a new servlet-class element with the given value will be created. Otherwise, the existing servlet-class element will be updated with the given value.

Specified by:
setServletClass in interface ServletType<T>
Returns:
the current instance of ServletType

removeServletClass

public ServletType<T> removeServletClass()
Removes the servlet-class element

Specified by:
removeServletClass in interface ServletType<T>
Returns:
the current instance of ServletType

getServletClass

public java.lang.String getServletClass()
Returns the servlet-class element

Specified by:
getServletClass in interface ServletType<T>
Returns:
the node defined for the element servlet-class

setJspFile

public ServletType<T> setJspFile(java.lang.String jspFile)
If not already created, a new jsp-file element with the given value will be created. Otherwise, the existing jsp-file element will be updated with the given value.

Specified by:
setJspFile in interface ServletType<T>
Returns:
the current instance of ServletType

removeJspFile

public ServletType<T> removeJspFile()
Removes the jsp-file element

Specified by:
removeJspFile in interface ServletType<T>
Returns:
the current instance of ServletType

getJspFile

public java.lang.String getJspFile()
Returns the jsp-file element

Specified by:
getJspFile in interface ServletType<T>
Returns:
the node defined for the element jsp-file