jakarta.faces.context.Flash 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

The newest version!

/*
 * 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 jakarta.faces.context;

import java.util.Map;

/**
 * @since 2.0
 */
public abstract class Flash implements Map
{
    /**
     * @since 2.2
     */
    public static final String NULL_VALUE = "jakarta.faces.context.Flash.NULL_VALUE";
    
    public abstract boolean isKeepMessages();

    public abstract boolean isRedirect();

    public abstract void keep(String key);

    public abstract void putNow(String key, Object value);
    
    public abstract void setKeepMessages(boolean newValue);
    
    public abstract void setRedirect(boolean newValue);
    
    public abstract void doPrePhaseActions(FacesContext context);
    
    public abstract void doPostPhaseActions(FacesContext context);
    
}