Top Description Methods
javax.servlet.annotation

public @Interface WebServlet

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
@Documented
Imports
java.lang.annotation.ElementType, .Target, .RetentionPolicy, .Retention, .Documented
Annotation used to declare a servlet.

This annotation is processed by the container at deployment time, and the corresponding servlet made available at the specified URL patterns.

Since
Servlet 3.0
See Also
javax.servlet.Servlet

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the servlet supports asynchronous operation mode
asyncSupported()

Declares whether the servlet supports asynchronous operation mode.

public String

Returns:

the description of the servlet
description()

The description of the servlet

public String

Returns:

the display name of the servlet
displayName()

The display name of the servlet

public WebInitParam[]

Returns:

the init parameters of the servlet
initParams()

The init parameters of the servlet

public String

Returns:

the large-icon of the servlet
largeIcon()

The large-icon of the servlet

public int

Returns:

the load-on-startup order of the servlet
loadOnStartup()

The load-on-startup order of the servlet

public String

Returns:

the name of the servlet
name()

The name of the servlet

public String

Returns:

the small-icon of the servlet
smallIcon()

The small-icon of the servlet

public String[]

Returns:

the URL patterns of the servlet
urlPatterns()

The URL patterns of the servlet

public String[]

Returns:

the URL patterns of the servlet
value()

The URL patterns of the servlet

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

asyncSupportedback to summary
public boolean asyncSupported()

Declares whether the servlet supports asynchronous operation mode.

Returns:boolean

true if the servlet supports asynchronous operation mode

See Also
javax.servlet.ServletRequest#startAsync, javax.servlet.ServletRequest#startAsync(ServletRequest, ServletResponse)
descriptionback to summary
public String description()

The description of the servlet

Returns:String

the description of the servlet

displayNameback to summary
public String displayName()

The display name of the servlet

Returns:String

the display name of the servlet

initParamsback to summary
public WebInitParam[] initParams()

The init parameters of the servlet

Returns:WebInitParam[]

the init parameters of the servlet

largeIconback to summary
public String largeIcon()

The large-icon of the servlet

Returns:String

the large-icon of the servlet

loadOnStartupback to summary
public int loadOnStartup()

The load-on-startup order of the servlet

Returns:int

the load-on-startup order of the servlet

nameback to summary
public String name()

The name of the servlet

Returns:String

the name of the servlet

smallIconback to summary
public String smallIcon()

The small-icon of the servlet

Returns:String

the small-icon of the servlet

urlPatternsback to summary
public String[] urlPatterns()

The URL patterns of the servlet

Returns:String[]

the URL patterns of the servlet

valueback to summary
public String[] value()

The URL patterns of the servlet

Returns:String[]

the URL patterns of the servlet