Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
   *
   * The contents of this file are subject to the terms of either the GNU
   * General Public License Version 2 only ("GPL") or the Common Development
   * and Distribution License("CDDL") (collectively, the "License").  You
   * may not use this file except in compliance with the License.  You can
  * obtain a copy of the License at
  * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
  * or packager/legal/LICENSE.txt.  See the License for the specific
  * language governing permissions and limitations under the License.
  *
  * When distributing the software, include this License Header Notice in each
  * file and include the License file at packager/legal/LICENSE.txt.
  *
  * GPL Classpath Exception:
  * Oracle designates this particular file as subject to the "Classpath"
  * exception as provided by Oracle in the GPL Version 2 section of the License
  * file that accompanied this code.
  *
  * Modifications:
  * If applicable, add the following below the License Header, with the fields
  * enclosed by brackets [] replaced by your own identifying information:
  * "Portions Copyright [year] [name of copyright owner]"
  *
  * Contributor(s):
  * If you wish your version of this file to be governed by only the CDDL or
  * only the GPL Version 2, indicate your decision by adding "[Contributor]
  * elects to include this software in this distribution under the [CDDL or GPL
  * Version 2] license."  If you don't indicate a single choice of license, a
  * recipient has the option to distribute your version of this file under
  * either the CDDL, the GPL Version 2 or to extend the choice of license to
  * its licensees as provided above.  However, if you add GPL Version 2 code
  * and therefore, elected the GPL Version 2 license, then the option applies
  * only if the new code is made subject to such option by the copyright
  * holder.
  */
 
 package javax.faces.event;
 
 import java.util.List;
 import java.util.Map;
 

This helper class provides context to the ExceptionQueuedEvent regarding the state of the system at the point in time when the ExceptionQueuedEvent occurs and links the ExceptionQueuedEvent to the javax.faces.context.ExceptionHandler by virtue of implementing SystemEventListener.

Since:
2.0
 
 
 public class ExceptionQueuedEventContext implements SystemEventListenerHolder {

    

The presence of an entry under this key in the Map returned from getAttributes() indicates the event occurred during the “before phase” part of the current lifecycle phase.

 
     public static final String IN_BEFORE_PHASE_KEY =
           ExceptionQueuedEventContext.class.getName() + ".IN_BEFORE_PHASE";
    
    

The presence of an entry under this key in the Map returned from getAttributes() indicates the event occurred during the “after phase” part of the current lifecycle phase.

 
     public static final String IN_AFTER_PHASE_KEY =
           ExceptionQueuedEventContext.class.getName() + ".IN_AFTER_PHASE";
 
     private FacesContext context;
     private Throwable thrown;
     private UIComponent component;
     private PhaseId phaseId;
     private Map<ObjectObjectattributes;
     private List<SystemEventListenerlistener;
 
     
     // ------------------------------------------------------------ Constructors
 

    

Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred.

Parameters:
context javax.faces.context.FacesContext for the current request
thrown the Throwable that is the context for this ExceptionQueuedEventContext instance.
    public ExceptionQueuedEventContext(FacesContext contextThrowable thrown) {
        this(contextthrownnullnull);
    }


    

Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component.

Parameters:
context javax.faces.context.FacesContext for the current request
thrown the Throwable that is the context for this ExceptionQueuedEventContext instance.
component the javax.faces.component.UIComponent instance to which this ExceptionQueuedEventContext pertains
                                 Throwable thrown,
                                 UIComponent component) {
        this (contextthrowncomponentnull);
    }
            
    

Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component, during the lifecycle phase phaseId.

Parameters:
context javax.faces.context.FacesContext for the current request
thrown the Throwable that is the context for this ExceptionQueuedEventContext instance.
component the UIComponent that is relevant to the context.
phaseId the PhaseId at the time this ExeceptionEventContext is created.
                                 Throwable thrown,
                                 UIComponent component,
                                 PhaseId phaseId) {
        this. = context;
        this. = thrown;
        this. = component;
        this. = ((phaseId == null)
                           ? context.getCurrentPhaseId()
                           : phaseId);
    }
    // ---------------------------------------------------------- Public Methods


    

Returns:
the javax.faces.context.FacesContext used to create this ExceptionQueuedEventContext instance.
    public FacesContext getContext() {
        return ;
    }

    

Return the exception property.

    public Throwable getException() {
        return ;
    }

    
    

Return the UIComponent which was being processed when the exception was thrown. If none or not available, this will be null.

    public UIComponent getComponent() {
        return this.;
    }


    

Return the PhaseId which was being processed when the exception was thrown. If none or not available, this will be null.

    public PhaseId getPhaseId() {
        return this.;
    }


    

Returns:
true if the exception occurred during the before phase processing for a particular lifecycle phase
    public boolean inBeforePhase() {
        return isAttributeDefined();
    }


    

Returns:
true if the exception occurred during the after phase processing for a particular lifecycle phase
    public boolean inAfterPhase() {
        return isAttributeDefined();
    }


    

A Map of attributes relevant to the context of this ExceptionQueuedEvent.

    public Map<ObjectObjectgetAttributes() {
        if (null == ) {
             = new HashMap<Object,Object>();
        }
        return ;
    }


    

Return a List that contains a single entry, the javax.faces.context.ExceptionHandler for the current request.

    public List<SystemEventListenergetListenersForEventClass(Class<? extends SystemEventfacesEventClass) {
        if (null == ) {
            List<SystemEventListenerlist = new ArrayList<SystemEventListener>(1);
            list.add(.getExceptionHandler());
             = Collections.unmodifiableList(list);
        }
        return ;
    }
    // --------------------------------------------------------- Private Methods
    private boolean isAttributeDefined(String key) {
        return (( != null) && .containsKey(key));
    }
New to GrepCode? Check out our FAQ X