javax.servlet.annotation

注釈型 WebServlet

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface WebServlet

サーブレットを宣言するために使用されるアノテーションです。

このアノテーションはデプロイ時にコンテナによって処理され、対応するサーブレットは指定されたURLパターンで利用可能になります。

導入されたバージョン:

Servlet 3.0

関連項目:

Servlet

任意要素のサマリー

任意要素

修飾子とタイプ	任意要素と説明
boolean	asyncSupported サーブレットが非同期処理モードをサポートしているかどうかを宣言します。
String	description サーブレットの説明
String	displayName サーブレットの表示名
WebInitParam[]	initParams サーブレットの初期化パラメーター
String	largeIcon サーブレット用の大きいアイコン
int	loadOnStartup サーブレットの初期化の順序。
String	name サーブレットの名前
String	smallIcon サーブレット用の小さいアイコン
String[]	urlPatterns サーブレットのURLパターン
String[]	value サーブレットのURLパターン

要素の詳細

name

public abstract String name

サーブレットの名前

戻り値:

サーブレットの名前

デフォルト:

""

value

public abstract String[] value

サーブレットのURLパターン

戻り値:

サーブレットのURLパターン

デフォルト:

{}

urlPatterns

public abstract String[] urlPatterns

サーブレットのURLパターン

戻り値:

サーブレットのURLパターン

デフォルト:

{}

loadOnStartup

public abstract int loadOnStartup

サーブレットの初期化の順序。正の数が指定されている場合、アプリケーションの起動時にサーブレットが起動する。

戻り値:

サーブレットの初期化の順序

デフォルト:

-1

initParams

public abstract WebInitParam[] initParams

サーブレットの初期化パラメーター

戻り値:

サーブレットの初期化パラメーター

デフォルト:

{}

asyncSupported

public abstract boolean asyncSupported

サーブレットが非同期処理モードをサポートしているかどうかを宣言します。

戻り値:

true ならばサーブレットが非同期処理モードをサポートしている

関連項目:

ServletRequest.startAsync(), ServletRequest.startAsync(ServletRequest, ServletResponse)

デフォルト:

false

smallIcon

public abstract String smallIcon

サーブレット用の小さいアイコン

戻り値:

サーブレット用の小さいアイコン

デフォルト:

""

largeIcon

public abstract String largeIcon

サーブレット用の大きいアイコン

戻り値:

サーブレット用の大きいアイコン

デフォルト:

""

description

public abstract String description

サーブレットの説明

戻り値:

サーブレットの説明

デフォルト:

""

displayName

public abstract String displayName

サーブレットの表示名

戻り値:

サーブレットの表示名

デフォルト:

""