All Downloads are FREE. Search and download functionalities are using the official Maven repository.

nextapp.echo.webcontainer.SynchronizePeerFactory Maven / Gradle / Ivy

/* 
 * This file is part of the Echo Web Application Framework (hereinafter "Echo").
 * Copyright (C) 2002-2009 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */

package nextapp.echo.webcontainer;

import nextapp.echo.app.util.PeerFactory;

/**
 * Factory for obtaining XXXSynchronizePeer implementations.
 */
public class SynchronizePeerFactory {

    /** Resource location of synchronization peer. */
    private static final String RESOURCE_NAME = "META-INF/nextapp/echo/SynchronizePeerBindings.properties";
    
    /** Peer factory for retrieving synchronization peers. */
    private static final PeerFactory peerFactory 
            = new PeerFactory(RESOURCE_NAME, Thread.currentThread().getContextClassLoader());
    
    /**
     * Non-instantiable class.
     */
    private SynchronizePeerFactory() { }
    
    /**
     * Retrieves the appropriate CommandSynchronizePeer for a given 
     * Command class.
     * 
     * @param commandClass the command class
     * @return the appropriate CommandSynchronizePeer
     */
    public static CommandSynchronizePeer getPeerForCommand(Class commandClass) {
        return (CommandSynchronizePeer) peerFactory.getPeerForObject(commandClass, true);
    }
    
    /**
     * Retrieves the appropriate ComponentSynchronizePeer for a given 
     * Component class.
     * 
     * @param componentClass the component class
     * @return the appropriate ComponentSynchronizePeer
     */
    public static ComponentSynchronizePeer getPeerForComponent(Class componentClass) {
        return getPeerForComponent(componentClass, true);
    }
    
    /**
     * Retrieves the appropriate ComponentSynchronizePeer for a given 
     * Component class.
     * 
     * @param componentClass the component class
     * @param searchSuperClasses flag indicating whether peers for superclasses should be returned if none
     *        can be found for the exact class.
     * @return the appropriate ComponentSynchronizePeer
     */
    public static ComponentSynchronizePeer getPeerForComponent(Class componentClass, boolean searchSuperClasses) {
        return (ComponentSynchronizePeer) peerFactory.getPeerForObject(componentClass, searchSuperClasses);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy