com.jme3.network.service.AbstractService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jme3-networking Show documentation
jMonkeyEngine is a 3-D game engine for adventurous Java developers
There is a newer version: 3.7.0-stable
/*
 * Copyright (c) 2015 jMonkeyEngine
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMonkeyEngine' 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 OWNER 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.
 */

package com.jme3.network.service;


/**
 *  Base class providing some default Service interface implementations
 *  as well as a few convenience methods such as getServiceManager()
 *  and getService(type).  Subclasses must at least override the
 *  onInitialize() method to handle service initialization.
 *
 *  @author    Paul Speed
 */
public abstract class AbstractService implements Service {
    
    private S serviceManager;
 
    protected AbstractService() {
    }
    
    /**
     *  Returns the ServiceManager that was passed to
     *  initialize() during service initialization.
     */
    protected S getServiceManager() {
        return serviceManager;
    }
 
    /**
     *  Retrieves the first sibling service of the specified
     *  type.
     */   
    @SuppressWarnings("unchecked")
    protected > T getService( Class type ) {
        return type.cast(serviceManager.getService(type));
    }    
    
    /**
     *  Initializes this service by keeping a reference to
     *  the service manager and calling onInitialize().
     */
    @Override
    public final void initialize( S serviceManager ) {
        this.serviceManager = serviceManager;
        onInitialize(serviceManager);
    }
 
    /**
     *  Called during initialize() for the subclass to perform
     *  implementation specific initialization.
     */   
    protected abstract void onInitialize( S serviceManager );
    
    /**
     *  Default implementation does nothing.  Implementations can
     *  override this to peform custom startup behavior.
     */
    @Override
    public void start() {    
    }
    
    /**
     *  Default implementation does nothing.  Implementations can
     *  override this to peform custom stop behavior.
     */
    @Override
    public void stop() {    
    }
    
    /**
     *  Default implementation does nothing.  Implementations can
     *  override this to peform custom termination behavior.
     */
    @Override
    public void terminate( S serviceManager ) {
    }
    
    @Override
    public String toString() {
        return getClass().getName() + "[serviceManager.class=" + (serviceManager != null ? serviceManager.getClass() : "") + "]";
    }
}