javax.faces.event.ExceptionQueuedEventContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation
The public API classes of the Apache MyFaces CORE JSF-2.2 project
There is a newer version: 4.1.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package javax.faces.event;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;

/**
 * @author Simon Lessard (latest modification by $Author: bommel $)
 * @version $Revision: 1187700 $ $Date: 2011-10-22 07:19:37 -0500 (Sat, 22 Oct 2011) $
 * 
 * @since 2.0
 */
public class ExceptionQueuedEventContext implements SystemEventListenerHolder
{
    // TODO: -=Leonardo Uribe=- This type of constants should be the same 
    // for ri and myfaces, to keep binary compatibility and pass TCK test.
    public static final String IN_AFTER_PHASE_KEY = ExceptionQueuedEventContext.class.getName() + ".IN_AFTER_PHASE";
    public static final String IN_BEFORE_PHASE_KEY = ExceptionQueuedEventContext.class.getName() + ".IN_BEFORE_PHASE";
    
    private Map _attributes;
    private UIComponent _component;
    private FacesContext _context;
    private PhaseId _phase;
    private Throwable _thrown;

    public ExceptionQueuedEventContext(FacesContext context, Throwable thrown)
    {
        this(context, thrown, null);
    }

    public ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component)
    {
        this(context, thrown, component, null);
    }

    public ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId)
    {
        _context = context;
        _thrown = thrown;
        _component = component;
        _phase = (phaseId == null ? context.getCurrentPhaseId() : phaseId);
    }
    
    public Map getAttributes()
    {
        if (_attributes == null)
        {
            _attributes = new HashMap();
        }
        
        return _attributes;
    }
    
    public UIComponent getComponent()
    {
        return _component;
    }
    
    public FacesContext getContext()
    {
        return _context;
    }
    
    public Throwable getException()
    {
        return _thrown;
    }

    /**
     * {@inheritDoc}
     */
    public List getListenersForEventClass(Class facesEventClass)
    {
        return Collections.singletonList((SystemEventListener)getContext().getExceptionHandler());
    }
    
    public PhaseId getPhaseId()
    {
        return _phase;
    }
    
    public boolean inAfterPhase()
    {
        return (_attributes != null && _attributes.containsKey(IN_AFTER_PHASE_KEY));
    }
    
    public boolean inBeforePhase()
    {
        return (_attributes != null && _attributes.containsKey(IN_BEFORE_PHASE_KEY));
    }
}