ServletType (ShrinkWrap Descriptors Aggregator 2.0.0 API)

All Superinterfaces:

Child<T>, JavaeeServletCommonType<T,ServletType<T>,ParamValueType<ServletType<T>>,RunAsType<ServletType<T>>,SecurityRoleRefType<ServletType<T>>>
```
public interface ServletType<T>
extends Child<T>, JavaeeServletCommonType<T,ServletType<T>,ParamValueType<ServletType<T>>,RunAsType<ServletType<T>>,SecurityRoleRefType<ServletType<T>>>
```
This interface defines the contract for the servletType xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IconType<ServletType<T>>`	`createIcon()` Creates a new `icon` element
`ParamValueType<ServletType<T>>`	`createInitParam()` Creates a new `init-param` element
`SecurityRoleRefType<ServletType<T>>`	`createSecurityRoleRef()` Creates a new `security-role-ref` element
`ServletType<T>`	`description(String... values)` Creates for all String objects representing `description` elements, a new `description` element
`ServletType<T>`	`displayName(String... values)` Creates for all String objects representing `display-name` elements, a new `display-name` element
`List<String>`	`getAllDescription()` Returns all `description` elements
`List<String>`	`getAllDisplayName()` Returns all `display-name` elements
`List<IconType<ServletType<T>>>`	`getAllIcon()` Returns all `icon` elements
`List<ParamValueType<ServletType<T>>>`	`getAllInitParam()` Returns all `init-param` elements
`List<SecurityRoleRefType<ServletType<T>>>`	`getAllSecurityRoleRef()` Returns all `security-role-ref` elements
`String`	`getId()` Returns the `id` attribute
`String`	`getJspFile()` Returns the `jsp-file` element
`Integer`	`getLoadOnStartup()` Returns the `load-on-startup` element
`IconType<ServletType<T>>`	`getOrCreateIcon()` If not already created, a new `icon` element will be created and returned.
`ParamValueType<ServletType<T>>`	`getOrCreateInitParam()` If not already created, a new `init-param` element will be created and returned.
`RunAsType<ServletType<T>>`	`getOrCreateRunAs()` If not already created, a new `run-as` element with the given value will be created.
`SecurityRoleRefType<ServletType<T>>`	`getOrCreateSecurityRoleRef()` If not already created, a new `security-role-ref` element will be created and returned.
`String`	`getServletClass()` Returns the `servlet-class` element
`String`	`getServletName()` Returns the `servlet-name` element
`ServletType<T>`	`id(String id)` Sets the `id` attribute
`ServletType<T>`	`jspFile(String jspFile)` Sets the `jsp-file` element
`ServletType<T>`	`loadOnStartup(Integer loadOnStartup)` Sets the `load-on-startup` element
`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>`	`removeId()` Removes the `id` attribute
`ServletType<T>`	`removeJspFile()` Removes the `jsp-file` element
`ServletType<T>`	`removeLoadOnStartup()` Removes the `load-on-startup` 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
`ServletType<T>`	`servletClass(String servletClass)` Sets the `servlet-class` element
`ServletType<T>`	`servletName(String servletName)` Sets the `servlet-name` element

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up

- Method Detail
  - description
```
ServletType<T> description(String... values)
```
    Creates for all String objects representing description elements, a new description element
    
    Parameters:
    
    values - list of description objects
    
    Returns:
    
    the current instance of ServletType
  - getAllDescription
```
List<String> getAllDescription()
```
    Returns all description elements
    
    Returns:
    
    list of description
  - removeAllDescription
```
ServletType<T> removeAllDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of ServletType
  - displayName
```
ServletType<T> displayName(String... values)
```
    Creates for all String objects representing display-name elements, a new display-name element
    
    Parameters:
    
    values - list of display-name objects
    
    Returns:
    
    the current instance of ServletType
  - getAllDisplayName
```
List<String> getAllDisplayName()
```
    Returns all display-name elements
    
    Returns:
    
    list of display-name
  - removeAllDisplayName
```
ServletType<T> removeAllDisplayName()
```
    Removes the display-name element
    
    Returns:
    
    the current instance of ServletType
  - getOrCreateIcon
```
IconType<ServletType<T>> getOrCreateIcon()
```
    If not already created, a new icon element will be created and returned. Otherwise, the first existing icon element will be returned.
    
    Returns:
    
    the instance defined for the element icon
  - createIcon
```
IconType<ServletType<T>> createIcon()
```
    Creates a new icon element
    
    Returns:
    
    the new created instance of IconType>
  - getAllIcon
```
List<IconType<ServletType<T>>> getAllIcon()
```
    Returns all icon elements
    
    Returns:
    
    list of icon
  - removeAllIcon
```
ServletType<T> removeAllIcon()
```
    Removes all icon elements
    
    Returns:
    
    the current instance of IconType>
  - servletName
```
ServletType<T> servletName(String servletName)
```
    Sets the servlet-name element
    
    Parameters:
    
    servletName - the value for the element servlet-name
    
    Returns:
    
    the current instance of ServletType
  - getServletName
```
String getServletName()
```
    Returns the servlet-name element
    
    Returns:
    
    the node defined for the element servlet-name
  - removeServletName
```
ServletType<T> removeServletName()
```
    Removes the servlet-name element
    
    Returns:
    
    the current instance of ServletType
  - servletClass
```
ServletType<T> servletClass(String servletClass)
```
    Sets the servlet-class element
    
    Parameters:
    
    servletClass - the value for the element servlet-class
    
    Returns:
    
    the current instance of ServletType
  - getServletClass
```
String getServletClass()
```
    Returns the servlet-class element
    
    Returns:
    
    the node defined for the element servlet-class
  - removeServletClass
```
ServletType<T> removeServletClass()
```
    Removes the servlet-class element
    
    Returns:
    
    the current instance of ServletType
  - jspFile
```
ServletType<T> jspFile(String jspFile)
```
    Sets the jsp-file element
    
    Parameters:
    
    jspFile - the value for the element jsp-file
    
    Returns:
    
    the current instance of ServletType
  - getJspFile
```
String getJspFile()
```
    Returns the jsp-file element
    
    Returns:
    
    the node defined for the element jsp-file
  - removeJspFile
```
ServletType<T> removeJspFile()
```
    Removes the jsp-file element
    
    Returns:
    
    the current instance of ServletType
  - getOrCreateInitParam
```
ParamValueType<ServletType<T>> getOrCreateInitParam()
```
    If not already created, a new init-param element will be created and returned. Otherwise, the first existing init-param element will be returned.
    
    Returns:
    
    the instance defined for the element init-param
  - createInitParam
```
ParamValueType<ServletType<T>> createInitParam()
```
    Creates a new init-param element
    
    Returns:
    
    the new created instance of ParamValueType>
  - getAllInitParam
```
List<ParamValueType<ServletType<T>>> getAllInitParam()
```
    Returns all init-param elements
    
    Returns:
    
    list of init-param
  - removeAllInitParam
```
ServletType<T> removeAllInitParam()
```
    Removes all init-param elements
    
    Returns:
    
    the current instance of ParamValueType>
  - loadOnStartup
```
ServletType<T> loadOnStartup(Integer loadOnStartup)
```
    Sets the load-on-startup element
    
    Parameters:
    
    loadOnStartup - the value for the element load-on-startup
    
    Returns:
    
    the current instance of ServletType
  - getLoadOnStartup
```
Integer getLoadOnStartup()
```
    Returns the load-on-startup element
    
    Returns:
    
    the node defined for the element load-on-startup
  - removeLoadOnStartup
```
ServletType<T> removeLoadOnStartup()
```
    Removes the load-on-startup element
    
    Returns:
    
    the current instance of ServletType
  - getOrCreateRunAs
```
RunAsType<ServletType<T>> getOrCreateRunAs()
```
    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.
    
    Returns:
    
    a new or existing instance of RunAsType>
  - removeRunAs
```
ServletType<T> removeRunAs()
```
    Removes the run-as element
    
    Returns:
    
    the current instance of ServletType
  - getOrCreateSecurityRoleRef
```
SecurityRoleRefType<ServletType<T>> getOrCreateSecurityRoleRef()
```
    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.
    
    Returns:
    
    the instance defined for the element security-role-ref
  - createSecurityRoleRef
```
SecurityRoleRefType<ServletType<T>> createSecurityRoleRef()
```
    Creates a new security-role-ref element
    
    Returns:
    
    the new created instance of SecurityRoleRefType>
  - getAllSecurityRoleRef
```
List<SecurityRoleRefType<ServletType<T>>> getAllSecurityRoleRef()
```
    Returns all security-role-ref elements
    
    Returns:
    
    list of security-role-ref
  - removeAllSecurityRoleRef
```
ServletType<T> removeAllSecurityRoleRef()
```
    Removes all security-role-ref elements
    
    Returns:
    
    the current instance of SecurityRoleRefType>
  - id
```
ServletType<T> id(String id)
```
    Sets the id attribute
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of ServletType
  - getId
```
String getId()
```
    Returns the id attribute
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
ServletType<T> removeId()
```
    Removes the id attribute
    
    Returns:
    
    the current instance of ServletType

Interface ServletType<T>

Method Summary

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

Method Detail

description

getAllDescription

removeAllDescription

displayName

getAllDisplayName

removeAllDisplayName

getOrCreateIcon

createIcon

getAllIcon

removeAllIcon

servletName

getServletName

removeServletName

servletClass

getServletClass

removeServletClass

jspFile

getJspFile

removeJspFile

getOrCreateInitParam

createInitParam

getAllInitParam

removeAllInitParam

loadOnStartup

getLoadOnStartup

removeLoadOnStartup

getOrCreateRunAs

removeRunAs

getOrCreateSecurityRoleRef

createSecurityRoleRef

getAllSecurityRoleRef

removeAllSecurityRoleRef

id

getId

removeId