2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 package javax.servlet.annotation;
19 import java.lang.annotation.Documented;
20 import java.lang.annotation.ElementType;
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 import java.lang.annotation.Target;
26 * The annotation used to declare an initialization parameter on a
27 * {@link javax.servlet.Servlet} or {@link javax.servlet.Filter}, within a
28 * {@link javax.servlet.annotation.WebFilter} or
29 * {@link javax.servlet.annotation.WebServlet} annotation.<br />
33 * <code>&#064;WebServlet(name="TestServlet", urlPatterns={"/test"},initParams={&#064;WebInitParam(name="test", value="true")})
34 * public class TestServlet extends HttpServlet { ... </code><br />
38 @Target({ElementType.TYPE})
39 @Retention(RetentionPolicy.RUNTIME)
41 public @interface WebInitParam {
44 * @return name of the initialization parameter
49 * @return value of the initialization parameter
54 * @return description of the initialization parameter
56 String description() default "";