org.jboss.shrinkwrap.descriptor.api.webcommon30
Interface ServletType<T>

All Superinterfaces:

Child<T>

public interface ServletType<T>
extends Child<T>

This interface defines the contract for the servletType xsd type

Since:

Generation date :2012-05-09T23:45:05.33-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

ServletType<T>	asyncSupported(Boolean asyncSupported) Sets the async-supported element
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
ServletType<T>	enabled(Boolean enabled) Sets the enabled 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	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.
MultipartConfigType<ServletType<T>>	getOrCreateMultipartConfig() If not already created, a new multipart-config element with the given value will be created.
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
Boolean	isAsyncSupported() Returns the async-supported element
Boolean	isEnabled() Returns the enabled element
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>	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
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

enabled

ServletType<T> enabled(Boolean enabled)

Sets the enabled element

Parameters:

enabled - the value for the element enabled

Returns:

the current instance of ServletType

isEnabled

Boolean isEnabled()

Returns the enabled element

Returns:

the node defined for the element enabled

removeEnabled

ServletType<T> removeEnabled()

Removes the enabled element

Returns:

the current instance of ServletType

asyncSupported

ServletType<T> asyncSupported(Boolean asyncSupported)

Sets the async-supported element

Parameters:

asyncSupported - the value for the element async-supported

Returns:

the current instance of ServletType

isAsyncSupported

Boolean isAsyncSupported()

Returns the async-supported element

Returns:

the node defined for the element async-supported

removeAsyncSupported

ServletType<T> removeAsyncSupported()

Removes the async-supported 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>

getOrCreateMultipartConfig

MultipartConfigType<ServletType<T>> getOrCreateMultipartConfig()

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.

Returns:

a new or existing instance of MultipartConfigType>

removeMultipartConfig

ServletType<T> removeMultipartConfig()

Removes the multipart-config element

Returns:

the current instance of ServletType