org.ginsim.common.utils

Class OpenUtils

java.lang.Object

org.ginsim.common.utils.OpenUtils

public class OpenUtils
extends Object

Open files and links (providing extensible "protocols" for specialised links handlers)

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,OpenHelper>	m_helper

Constructor Summary

Constructors

Constructor and Description
OpenUtils()

Method Summary

Modifier and Type	Method and Description
static void	addHelperClass(String key, OpenHelper helper) Register a protocol handler.
static void	addHelperClassAlias(String alias, String key) Add an alias for an existing handler.
static OpenHelper	getHelper(Object key) Get the registered helper for a given "protocol"
static String	getLink(Object protocol, Object value) Get a standard link (URI) for a given (protocol,value) pair
static boolean	open(Object protocol, Object value) Open a link.
static boolean	openFile(String filepath) Open a file at the given path
static boolean	openURI(String uri) Open an URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_helper

protected static Map<String,OpenHelper> m_helper

Constructor Detail

OpenUtils

public OpenUtils()

Method Detail

addHelperClass

public static void addHelperClass(String key,
                                  OpenHelper helper)

Register a protocol handler.

Parameters:

key - the name of the "protocol" to handle

helper - the handler itself

addHelperClassAlias

public static void addHelperClassAlias(String alias,
                                       String key)

Add an alias for an existing handler. Note that this will register the existing handler for the alias: it will not remember the alias and thus it will fail is called before registering the main handler.

Parameters:

alias - the new name

key - the existing "protocol"

getHelper

public static OpenHelper getHelper(Object key)

Get the registered helper for a given "protocol"

Parameters:

key - the "protocol" name

Returns:

the registered handler or null.

getLink

public static String getLink(Object protocol,
                             Object value)

Get a standard link (URI) for a given (protocol,value) pair

Parameters:

protocol -

value -

Returns:

an URI for this link.

open

public static boolean open(Object protocol,
                           Object value)

Open a link. It will look for a handler to open it and fallback to opening the URI obtained with the getLink() method.

Parameters:

protocol -

value -

Returns:

true if the link could be opened, false otherwise.

openURI

public static boolean openURI(String uri)

Open an URI. This uses java's Desktop.browse() method and will fail if this method does not works. It should work on most recent java installations (tested of Linux, OSX and Windows)

Parameters:

uri - the URI to open

Returns:

true if the link could be opened, false otherwise.

openFile

public static boolean openFile(String filepath)

Open a file at the given path

Parameters:

filepath - the path of the file

Returns:

true if it managed