lib/servlet-api/javax/servlet/ServletRequestAttributeEvent.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 of changes to the attributes of the
  21  * servlet request in an application.
  22  *
  23  * @see ServletRequestAttributeListener
  24  * @since Servlet 2.4
  25  */
  26 public class ServletRequestAttributeEvent extends ServletRequestEvent {
  27     private static final long serialVersionUID = 1L;
  28
  29     private final String name;
  30     private final Object value;
  31
  32     /**
  33      * Construct a ServletRequestAttributeEvent giving the servlet context of
  34      * this web application, the ServletRequest whose attributes are changing
  35      * and the name and value of the attribute.
  36      *
  37      * @param sc
  38      *            the ServletContext that is sending the event.
  39      * @param request
  40      *            the ServletRequest that is sending the event.
  41      * @param name
  42      *            the name of the request attribute.
  43      * @param value
  44      *            the value of the request attribute.
  45      */
  46     public ServletRequestAttributeEvent(ServletContext sc,
  47             ServletRequest request, String name, Object value) {
  48         super(sc, request);
  49         this.name = name;
  50         this.value = value;
  51     }
  52
  53     /**
  54      * Return the name of the attribute that changed on the ServletRequest.
  55      *
  56      * @return the name of the changed request attribute
  57      */
  58     public String getName() {
  59         return this.name;
  60     }
  61
  62     /**
  63      * Returns the value of the attribute that has been added, removed or
  64      * replaced. If the attribute was added, this is the value of the attribute.
  65      * If the attribute was removed, this is the value of the removed attribute.
  66      * If the attribute was replaced, this is the old value of the attribute.
  67      *
  68      * @return the value of the changed request attribute
  69      */
  70     public Object getValue() {
  71         return this.value;
  72     }
  73 }