View Javadoc
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  
18  package org.apache.log4j.plugins;
19  
20  import java.util.EventObject;
21  
22  
23  /**
24   * All Plugin events are encapsulated in this class, which
25   * simply contains the source Plugin, but may in future include more
26   * information.
27   *
28   * @author Paul Smith
29   */
30  public class PluginEvent extends EventObject {
31      /**
32       * @param source The source plugin of the event
33       */
34      PluginEvent(final Plugin source) {
35          super(source);
36      }
37  
38      /**
39       * Returns the source Plugin of this event, which is simple
40       * the getSource() method casted to Plugin for convenience.
41       *
42       * @return Plugin source of this event
43       */
44      public Plugin getPlugin() {
45          return (Plugin) getSource();
46      }
47  }