MultiviewFormWorkflowRedirectionEnum.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.forms.web.admin;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Enumeration of all possible redirection after an action of the workflow
 */
public enum MultiviewFormWorkflowRedirectionEnum
{
    LIST( "list" ), //
    DETAILS( "details" ), //
    DEFAULT( "default" );

    // Variables
    private static final Map<String, MultiviewFormWorkflowRedirectionEnum> _mapValueNames = new LinkedHashMap<>( );
    private String _strValue;

    static
    {
        for ( MultiviewFormWorkflowRedirectionEnum workflowRedirectionEnum : MultiviewFormWorkflowRedirectionEnum.values( ) )
        {
            _mapValueNames.put( workflowRedirectionEnum.getValue( ), workflowRedirectionEnum );
        }
    }

    /**
     * Constructor - never called
     * 
     * @param strValue
     *            The value of the enumeration
     */
    MultiviewFormWorkflowRedirectionEnum( String strValue )
    {
        _strValue = strValue;
    }

    /**
     * Return the value of the enumeration
     * 
     * @return the value of the enumeration
     */
    public String getValue( )
    {
        return _strValue;
    }

    /**
     * Return the name of the enumeration by its value or the default if not found
     * 
     * @param strEnumValue
     *            The value of the enumeration to retrieve the name from
     * @return the name of the enumeration by its value or the default if not found
     */
    public static MultiviewFormWorkflowRedirectionEnum getEnumNameByValue( String strEnumValue )
    {
        MultiviewFormWorkflowRedirectionEnum workflowRedirectionEnum = _mapValueNames.get( strEnumValue );

        if ( workflowRedirectionEnum == null )
        {
            workflowRedirectionEnum = MultiviewFormWorkflowRedirectionEnum.DEFAULT;
        }

        return workflowRedirectionEnum;
    }
}