WidgetHandlerService.java

/*
 * Copyright (c) 2002-2014, Mairie de 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.myportal.service.handler;

import fr.paris.lutece.portal.service.spring.SpringContextService;
import fr.paris.lutece.util.ReferenceList;

import java.util.List;

/**
 *
 * WidgetHandlerService
 *
 */
public final class WidgetHandlerService
{
    private static WidgetHandlerService _singleton;
    private static List<WidgetHandler> _listHandlers;

    /**
     * Constructor
     */
    private WidgetHandlerService( )
    {
    }

    /**
     * Get an instance of {@link WidgetHandlerService}
     * 
     * @return an instance of {@link WidgetHandlerService}
     */
    public static synchronized WidgetHandlerService instance( )
    {
        if ( _singleton == null )
        {
            _singleton = new WidgetHandlerService( );
            _listHandlers = SpringContextService.getBeansOfType( WidgetHandler.class );
        }

        return _singleton;
    }

    /**
     * Get the handlers as a {@link ReferenceList}
     * 
     * @return a {@link ReferenceList}
     */
    public ReferenceList getHandlers( )
    {
        ReferenceList list = new ReferenceList( );

        for ( WidgetHandler handler : _listHandlers )
        {
            list.addItem( handler.getName( ), handler.getDescription( ) );
        }

        return list;
    }

    /**
     * Get a handler given a type
     * 
     * @param strType
     *            the type
     * @return a {@link WidgetHandler}
     */
    public WidgetHandler getHandler( String strType )
    {
        for ( WidgetHandler handler : _listHandlers )
        {
            if ( handler.getName( ).equals( strType ) )
            {
                return handler;
            }
        }

        return null;
    }
}