org.ardulink.core.convenience

Class Links

java.lang.Object

org.ardulink.core.convenience.Links

public final class Links
extends java.lang.Object

Ardulink - return to homepage

v2.1.1 Gordio - SERVICE PACK 1

This is a convenience layer for retrieving links. Links retrieved via this class are cached and shared.

Method Summary

Modifier and Type	Method and Description
static Link	getDefault() Returns the default Link which is a connection to the first serial port.
static LinkManager.Configurer	getDefaultConfigurer()
static Link	getLink(LinkManager.Configurer configurer)
static Link	getLink(java.lang.String uri) Returns a shared Link to the passed URI.
static Link	getLink(java.net.URI uri) Returns a shared Link to the passed URI.
static boolean	isConfigured(LinkManager.ConfigAttribute attribute)
static LinkManager.Configurer	setChoiceValues(LinkManager.Configurer configurer)

Methods inherited from class java.lang.Object

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

Method Detail

getDefault

public static Link getDefault()

Returns the default Link which is a connection to the first serial port.

Returns:

default Link

getDefaultConfigurer

public static LinkManager.Configurer getDefaultConfigurer()

getLink

public static Link getLink(java.lang.String uri)

Returns a shared Link to the passed URI. If the Link already was created the cached Link is returned. If the Link is not used anymore it should be closed by calling Closeable.close() on it. Doing so will decrease the usage counter and finally in cache eviction if it's unused.

Parameters:

uri - the URI to create the Link for

Returns:

shared Link for the passed URI or a newly created one if no Link for that URI exists

Throws:

java.lang.Exception

getLink

public static Link getLink(java.net.URI uri)

Returns a shared Link to the passed URI. If the Link already was created the cached Link is returned. If the Link is not used anymore it should be closed by calling Closeable.close() on it. Doing so will decrease the usage counter and finally in cache eviction if it's unused.

Parameters:

uri - the URI to create the Link for

Returns:

shared Link for the passed URI or a newly created one if no Link for that URI exists

Throws:

java.lang.Exception

getLink

public static Link getLink(LinkManager.Configurer configurer)

setChoiceValues

public static LinkManager.Configurer setChoiceValues(LinkManager.Configurer configurer)

isConfigured

public static boolean isConfigured(LinkManager.ConfigAttribute attribute)