lib/servlet-api/javax/servlet/ServletContextAttributeEvent.java

   1 /*
   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
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17 package javax.servlet;
  18
  19 /**
  20  * This is the event class for notifications about changes to the attributes of
  21  * the servlet context of a web application.
  22  *
  23  * @see ServletContextAttributeListener
  24  * @since v 2.3
  25  */
  26 public class ServletContextAttributeEvent extends ServletContextEvent {
  27     private static final long serialVersionUID = 1L;
  28
  29     private final String name;
  30     private final Object value;
  31
  32     /**
  33      * Construct a ServletContextAttributeEvent from the given context for the
  34      * given attribute name and attribute value.
  35      */
  36     public ServletContextAttributeEvent(ServletContext source, String name,
  37             Object value) {
  38         super(source);
  39         this.name = name;
  40         this.value = value;
  41     }
  42
  43     /**
  44      * Return the name of the attribute that changed on the ServletContext.
  45      */
  46     public String getName() {
  47         return this.name;
  48     }
  49
  50     /**
  51      * Returns the value of the attribute that has been added, removed, or
  52      * replaced. If the attribute was added, this is the value of the attribute.
  53      * If the attribute was removed, this is the value of the removed attribute.
  54      * If the attribute was replaced, this is the old value of the attribute.
  55      */
  56     public Object getValue() {
  57         return this.value;
  58     }
  59 }