com.xatkit.core

Class RuntimePlatformRegistry

java.lang.Object

com.xatkit.core.RuntimePlatformRegistry

public class RuntimePlatformRegistry
extends Object

A registry that stores RuntimePlatforms.

Constructor Summary

Constructors

Constructor and Description
RuntimePlatformRegistry() Constructs a new instance of the registry and initializes its platformToRuntime.

Method Summary

Modifier and Type	Method and Description
void	clearRuntimePlatforms() Unregisters all the RuntimePlatforms from this registry.
Collection<com.xatkit.platform.PlatformDefinition>	getLoadedPlatformDefinitions() Returns a Collection containing all the loaded PlatformDefinitions.
com.xatkit.platform.PlatformDefinition	getPlatformDefinition(String platformName)
RuntimePlatform	getRuntimePlatform(com.xatkit.platform.PlatformDefinition platformDefinition) Returns the RuntimePlatform associated to the provided platformDefinition.
RuntimePlatform	getRuntimePlatform(String platformName) Returns the RuntimePlatform associated to the provided platformName.
Collection<RuntimePlatform>	getRuntimePlatforms() Returns all the RuntimePlatforms stored in this registry.
void	registerLoadedPlatformDefinition(com.xatkit.platform.PlatformDefinition platformDefinition) Registeres the provided platformDefinition using its name.
void	registerRuntimePlatform(RuntimePlatform platform) Registers the provided platform using its name.
void	registerRuntimePlatform(String platformName, RuntimePlatform platform) Registers the provided platform with the provided name.
void	unregisterRuntimePlatform(RuntimePlatform platform) Unregisters the provided platform.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuntimePlatformRegistry

public RuntimePlatformRegistry()

Constructs a new instance of the registry and initializes its platformToRuntime.

Method Detail

registerLoadedPlatformDefinition

public void registerLoadedPlatformDefinition(com.xatkit.platform.PlatformDefinition platformDefinition)

Registeres the provided platformDefinition using its name.

Registered PlatformDefinitions can be accessed using getLoadedPlatformDefinitions(). Note that a registered PlatformDefinition does not imply that the corresponding RuntimePlatform has been loaded.

Parameters:

platformDefinition - the PlatformDefinition to register

See Also:

getLoadedPlatformDefinitions()

getLoadedPlatformDefinitions

public Collection<com.xatkit.platform.PlatformDefinition> getLoadedPlatformDefinitions()

Returns a Collection containing all the loaded PlatformDefinitions.

Returns:

a Collection containing all the loaded PlatformDefinitions

registerRuntimePlatform

public void registerRuntimePlatform(RuntimePlatform platform)

Registers the provided platform using its name.

Parameters:

platform - the RuntimePlatform to register

See Also:

registerRuntimePlatform(String, RuntimePlatform)

registerRuntimePlatform

public void registerRuntimePlatform(String platformName,
                                    RuntimePlatform platform)

Registers the provided platform with the provided name.

This method is used to bind abstract platforms to their concrete implementation. In this case the provided platformName is typically the name of the abstract platform, and the concrete RuntimePlatform is the implementation loaded from the Xatkit configuration.

Parameters:

platformName - the name to use to register the RuntimePlatform

platform - the RuntimePlatform to register

unregisterRuntimePlatform

public void unregisterRuntimePlatform(RuntimePlatform platform)

Unregisters the provided platform.

Parameters:

platform - the RuntimePlatform to unregister

clearRuntimePlatforms

public void clearRuntimePlatforms()

Unregisters all the RuntimePlatforms from this registry.

getPlatformDefinition

public com.xatkit.platform.PlatformDefinition getPlatformDefinition(String platformName)

getRuntimePlatform

public RuntimePlatform getRuntimePlatform(String platformName)

Returns the RuntimePlatform associated to the provided platformName.

RuntimePlatform are registered using the RuntimePlatform.getName() method.

Parameters:

platformName - the name of the RuntimePlatform to retrieve

Returns:

the RuntimePlatform associated to the provided platformName

getRuntimePlatform

public RuntimePlatform getRuntimePlatform(com.xatkit.platform.PlatformDefinition platformDefinition)

Returns the RuntimePlatform associated to the provided platformDefinition.

The provided PlatformDefinition should follow xatkit's naming conventions, and provide a PlatformDefinition.getName() method that returns the name of the concrete RuntimePlatform class to retrieve.

Parameters:

platformDefinition - the PlatformDefinition representing the RuntimePlatform to retrieve

Returns:

the RuntimePlatform associated to the provided platformDefinition

getRuntimePlatforms

public Collection<RuntimePlatform> getRuntimePlatforms()

Returns all the RuntimePlatforms stored in this registry.

Returns:

all the RuntimePlatforms stored in this registry