View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package javax.faces.event;
20  
21  import javax.faces.context.FacesContext;
22  import javax.faces.lifecycle.Lifecycle;
23  import java.util.EventObject;
24  
25  /**
26   * see Javadoc of <a href="http://java.sun.com/javaee/javaserverfaces/1.2/docs/api/index.html">JSF Specification</a>
27   * 
28   * @author Thomas Spiegl (latest modification by $Author: bommel $)
29   * @version $Revision: 1187700 $ $Date: 2011-10-22 12:19:37 +0000 (Sat, 22 Oct 2011) $
30   */
31  public class PhaseEvent extends EventObject
32  {
33      private static final long serialVersionUID = -7235692965954486239L;
34      // FIELDS
35      private FacesContext _facesContext;
36      private PhaseId _phaseId;
37  
38      // CONSTRUCTORS
39      public PhaseEvent(FacesContext facesContext, PhaseId phaseId, Lifecycle lifecycle)
40      {
41          super(lifecycle);
42          if (facesContext == null)
43              throw new NullPointerException("facesContext");
44          if (phaseId == null)
45              throw new NullPointerException("phaseId");
46          if (lifecycle == null)
47              throw new NullPointerException("lifecycle");
48  
49          _facesContext = facesContext;
50          _phaseId = phaseId;
51      }
52  
53      // METHODS
54      public FacesContext getFacesContext()
55      {
56          return _facesContext;
57      }
58  
59      public PhaseId getPhaseId()
60      {
61          return _phaseId;
62      }
63  
64      @Override
65      public int hashCode()
66      {
67          final int PRIME = 31;
68          int result = 1;
69          result = PRIME * result + ((source == null) ? 0 : source.hashCode());
70          result = PRIME * result + ((_facesContext == null) ? 0 : _facesContext.hashCode());
71          result = PRIME * result + ((_phaseId == null) ? 0 : _phaseId.hashCode());
72          return result;
73      }
74  
75      @Override
76      public boolean equals(Object obj)
77      {
78          if (this == obj)
79              return true;
80          if (obj == null)
81              return false;
82          if (getClass() != obj.getClass())
83              return false;
84          final PhaseEvent other = (PhaseEvent) obj;
85          if (source == null)
86          {
87              if (other.source != null)
88                  return false;
89          }
90          else if (!source.equals(other.source))
91              return false;
92          if (_facesContext == null)
93          {
94              if (other._facesContext != null)
95                  return false;
96          }
97          else if (!_facesContext.equals(other._facesContext))
98              return false;
99          if (_phaseId == null)
100         {
101             if (other._phaseId != null)
102                 return false;
103         }
104         else if (!_phaseId.equals(other._phaseId))
105             return false;
106         return true;
107     }
108 
109 }