net.java.games.input.ControllerEnvironment Maven / Gradle / Ivy
/*
* %W% %E%
*
* Copyright 2002 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
/*****************************************************************************
* Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistribution of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* - Redistribution in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materails provided with the distribution.
*
* Neither the name Sun Microsystems, Inc. or the names of the contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* This software is provided "AS IS," without a warranty of any kind.
* ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
* ANY IMPLIED WARRANT OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
* NON-INFRINGEMEN, ARE HEREBY EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND
* ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS
* A RESULT OF USING, MODIFYING OR DESTRIBUTING THIS SOFTWARE OR ITS
* DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST
* REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL,
* INCIDENTAL OR PUNITIVE DAMAGES. HOWEVER CAUSED AND REGARDLESS OF THE THEORY
* OF LIABILITY, ARISING OUT OF THE USE OF OUR INABILITY TO USE THIS SOFTWARE,
* EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
*
* You acknowledge that this software is not designed or intended for us in
* the design, construction, operation or maintenance of any nuclear facility
*
*****************************************************************************/
package net.java.games.input;
import java.io.File;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* A ControllerEnvironment represents a collection of controllers that are
* physically or logically linked. By default, this corresponds to the
* environment for the local machine.
*
* In this reference implementation, this class can also be used to register
* controllers with the default environment as "plug-ins". A plug-in is
* created by subclassing ControllerEnvironment with a class that has a public
* no-argument constructor, implements the net.java.games.util.plugins.Plugin
* interface and has a name ending in "Plugin".
* (See net.java.games.input.DirectInputEnvironmentPlugin in the DXplugin
* part of the source tree for an example.)
*
* When the DefaultControllerEnvrionment is instanced it uses the plugin library
* to look for Plugins in both [java.home]/lib/controller and
* [user.dir]/controller. This allows controller plugins to be installed either
* globally for the entire Java environment or locally for just one particular
* Java app.
*
* For more information on the organization of plugins within the controller
* root directories, see net.java.games.util.plugins.Plugins (Note the
* plural -- "Plugins" not "Plugin" which is just a marker interface.)
*
*/
public abstract class ControllerEnvironment {
static void log(String msg) {
Logger.getLogger(ControllerEnvironment.class.getName()).info(msg);
}
/**
* The default controller environment
*/
private static ControllerEnvironment defaultEnvironment =
new DefaultControllerEnvironment();
/**
* List of controller listeners
*/
protected final ArrayList controllerListeners = new ArrayList<>();
/**
* Protected constructor for subclassing.
*/
protected ControllerEnvironment() {
if(System.getProperty("jinput.loglevel") != null) {
String loggerName = ControllerEnvironment.class.getPackage().getName();
Level level = Level.parse(System.getProperty("jinput.loglevel"));
Logger.getLogger(loggerName).setLevel(level);
}
}
/**
* Returns a list of all controllers available to this environment,
* or an empty array if there are no controllers in this environment.
*/
public abstract Controller[] getControllers();
/**
* Adds a listener for controller state change events.
*/
public void addControllerListener(ControllerListener l) {
assert l != null;
controllerListeners.add(l);
}
/**
* Returns the isSupported status of this environment.
* What makes an environment supported or not is up to the
* particular plugin, but may include OS or available hardware.
*/
public abstract boolean isSupported();
/**
* Removes a listener for controller state change events.
*/
public void removeControllerListener(ControllerListener l) {
assert l != null;
controllerListeners.remove(l);
}
/**
* Creates and sends an event to the controller listeners that a controller
* has been added.
*/
protected void fireControllerAdded(Controller c) {
ControllerEvent ev = new ControllerEvent(c);
Iterator it = controllerListeners.iterator();
while (it.hasNext()) {
it.next().controllerAdded(ev);
}
}
/**
* Creates and sends an event to the controller listeners that a controller
* has been lost.
*/
protected void fireControllerRemoved(Controller c) {
ControllerEvent ev = new ControllerEvent(c);
Iterator it = controllerListeners.iterator();
while (it.hasNext()) {
it.next().controllerRemoved(ev);
}
}
/**
* Returns the default environment for input controllers.
* This usually corresponds to the environment for the local machine.
*/
public static ControllerEnvironment getDefaultEnvironment() {
return defaultEnvironment;
}
}