net.sourceforge.ccxjc.it.model.pkg.collections.novalueclass.javaee
Interface ServletType

All Known Implementing Classes:
ServletTypeImpl

public interface ServletType

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

Java class for servletType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="servletType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="servlet-name" type="{http://java.sun.com/xml/ns/javaee}servlet-nameType"/>
         <choice>
           <element name="servlet-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
           <element name="jsp-file" type="{http://java.sun.com/xml/ns/javaee}jsp-fileType"/>
         </choice>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="load-on-startup" type="{http://java.sun.com/xml/ns/javaee}load-on-startupType" minOccurs="0"/>
         <element name="run-as" type="{http://java.sun.com/xml/ns/javaee}run-asType" minOccurs="0"/>
         <element name="security-role-ref" type="{http://java.sun.com/xml/ns/javaee}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 


Method Summary
 List<DescriptionType> getDescription()
          Gets the value of the description property.
 List<DisplayNameType> getDisplayName()
          Gets the value of the displayName property.
 List<IconType> getIcon()
          Gets the value of the icon property.
 String getId()
          Gets the value of the id property.
 List<ParamValueType> getInitParam()
          Gets the value of the initParam property.
 JspFileType getJspFile()
          Gets the value of the jspFile property.
 String getLoadOnStartup()
          Gets the value of the loadOnStartup property.
 RunAsType getRunAs()
          Gets the value of the runAs property.
 List<SecurityRoleRefType> getSecurityRoleRef()
          Gets the value of the securityRoleRef property.
 FullyQualifiedClassType getServletClass()
          Gets the value of the servletClass property.
 ServletNameType getServletName()
          Gets the value of the servletName property.
 void setId(String value)
          Sets the value of the id property.
 void setJspFile(JspFileType value)
          Sets the value of the jspFile property.
 void setLoadOnStartup(String value)
          Sets the value of the loadOnStartup property.
 void setRunAs(RunAsType value)
          Sets the value of the runAs property.
 void setServletClass(FullyQualifiedClassType value)
          Sets the value of the servletClass property.
 void setServletName(ServletNameType value)
          Sets the value of the servletName property.
 

Method Detail

getDescription

List<DescriptionType> getDescription()
Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType


getDisplayName

List<DisplayNameType> getDisplayName()
Gets the value of the displayName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

For example, to add a new item, do as follows:

    getDisplayName().add(newItem);
 

Objects of the following type(s) are allowed in the list DisplayNameType


getIcon

List<IconType> getIcon()
Gets the value of the icon property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the icon property.

For example, to add a new item, do as follows:

    getIcon().add(newItem);
 

Objects of the following type(s) are allowed in the list IconType


getServletName

ServletNameType getServletName()
Gets the value of the servletName property.

Returns:
possible object is ServletNameType

setServletName

void setServletName(ServletNameType value)
Sets the value of the servletName property.

Parameters:
value - allowed object is ServletNameType

getServletClass

FullyQualifiedClassType getServletClass()
Gets the value of the servletClass property.

Returns:
possible object is FullyQualifiedClassType

setServletClass

void setServletClass(FullyQualifiedClassType value)
Sets the value of the servletClass property.

Parameters:
value - allowed object is FullyQualifiedClassType

getJspFile

JspFileType getJspFile()
Gets the value of the jspFile property.

Returns:
possible object is JspFileType

setJspFile

void setJspFile(JspFileType value)
Sets the value of the jspFile property.

Parameters:
value - allowed object is JspFileType

getInitParam

List<ParamValueType> getInitParam()
Gets the value of the initParam property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initParam property.

For example, to add a new item, do as follows:

    getInitParam().add(newItem);
 

Objects of the following type(s) are allowed in the list ParamValueType


getLoadOnStartup

String getLoadOnStartup()
Gets the value of the loadOnStartup property.

Returns:
possible object is String

setLoadOnStartup

void setLoadOnStartup(String value)
Sets the value of the loadOnStartup property.

Parameters:
value - allowed object is String

getRunAs

RunAsType getRunAs()
Gets the value of the runAs property.

Returns:
possible object is RunAsType

setRunAs

void setRunAs(RunAsType value)
Sets the value of the runAs property.

Parameters:
value - allowed object is RunAsType

getSecurityRoleRef

List<SecurityRoleRefType> getSecurityRoleRef()
Gets the value of the securityRoleRef property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the securityRoleRef property.

For example, to add a new item, do as follows:

    getSecurityRoleRef().add(newItem);
 

Objects of the following type(s) are allowed in the list SecurityRoleRefType


getId

String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String


Copyright © 2009 The CC-XJC Community. All Rights Reserved.