$ A B C D E F G H I L M N O P R S T U V W _

$

$(String) - Static method in class org.robokind.api.common.localization.Localizer

Return the String associated with the given key for the set LanguageLocale

$_(String) - Static method in class org.robokind.api.common.localization.Localizer

Return the String associated with the given key followed by a space: ' '.

A

AbstractPlayable - Class in org.robokind.api.common.playable

A basic implementation of Playable.

AbstractPlayable() - Constructor for class org.robokind.api.common.playable.AbstractPlayable

Creates a new Playable in a pending state.

adapt(A) - Method in class org.robokind.api.common.utils.ComplexAdapter

adapt(A) - Method in class org.robokind.api.common.utils.PolymorphicAdapter

addAction(String, PropertyChangeActionBase) - Method in class org.robokind.api.common.property.PropertyChangeMonitor

Adds a PropertyChangeAction to be fired when an event with the given name is found.

addAdapter(String, Adapter<A, B>) - Method in class org.robokind.api.common.utils.PolymorphicAdapter

addListener(Listener<Msg>) - Method in class org.robokind.api.common.utils.EventRepeater

AddOnUtils - Class in org.robokind.api.common.services.addon

AddOnUtils() - Constructor for class org.robokind.api.common.services.addon.AddOnUtils

addPlayableListener(PlayableListener) - Method in class org.robokind.api.common.playable.AbstractPlayable

addPlayableListener(PlayableListener) - Method in interface org.robokind.api.common.playable.Playable

Adds a PlayableListener to be notified when the PlayState changes.

addPropertyChangeListener(PropertyChangeListener) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Add a PropertyChangeListener to the PropertyChangeSupport.

addPropertyChangeListener(String, PropertyChangeListener) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Add a PropertyChangeListener to the PropertyChangeSupport for a specific event.

addPropertyChangeListener(PropertyChangeListener) - Method in interface org.robokind.api.common.property.PropertyChangeSource

Adds a listener to be notified for all property changes.

addPropertyChangeListener(String, PropertyChangeListener) - Method in interface org.robokind.api.common.property.PropertyChangeSource

Adds a listener for a specific property change event.

afterComplete(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Called after the Playable is marked Completed.

B

BooleanRange - Class in org.robokind.api.common.position

BooleanRange(NormalizedDouble) - Constructor for class org.robokind.api.common.position.BooleanRange

bound(double, double, double) - Static method in class org.robokind.api.common.utils.Utils

Ensures: low <= n <= high

bound(long, long, long) - Static method in class org.robokind.api.common.utils.Utils

Ensures: low <= n <= high

bound(int, int, int) - Static method in class org.robokind.api.common.utils.Utils

Ensures: low <= n <= high

build(T) - Method in class org.robokind.api.common.services.EmptyFactory

build(ServiceConfig) - Method in interface org.robokind.api.common.services.ServiceFactory

Builds a new instance of a Service from the given ServiceConfig.

buildPropertyChangeSupport(Object) - Static method in class org.robokind.api.common.property.PropertyChangeUtils

Creates a new PropertyChangeSupport.

buildService(BundleContext, VersionProperty, VersionProperty, Param, Class<Param>, Class<ServiceClass>) - Static method in class org.robokind.api.common.services.ServiceConnectionDirectory

Locates the appropriate ConfigurationLoader and ServiceFactory matching the given versions, and able to create Service instance of the ServiceClass using the given param.

buildService() - Method in class org.robokind.api.common.services.ServiceContext

Builds a Service using the ServiceFactory and ServiceConfig.

buildServiceContext(BundleContext, VersionProperty, VersionProperty, Class<ServiceClass>, Class<Param>) - Static method in class org.robokind.api.common.services.ServiceConnectionDirectory

Locates an appropriate ConfigurationLoader and ServiceFactory matching the given versions, and able to create Service instance of the ServiceClass using a parameter of the given Param Class.

bytesToString(byte[]) - Static method in class org.robokind.api.common.utils.Utils

Creates a String from the given byte array.

C

checksum(byte[], int, int, boolean, byte...) - Static method in class org.robokind.api.common.utils.Utils

Calculates a checksum from the data and extra bytes

cleanupService(T) - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

clearAllListeners() - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Removes all PropertyChangeListeners.

clearListeners(String) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Removes all PropertyChangeListeners associated with the given property name.

clone() - Method in class org.robokind.api.common.config.VersionProperty

clone() - Method in class org.robokind.api.common.position.NormalizedDouble

clone() - Method in class org.robokind.api.common.types.Temperature

clone() - Method in class org.robokind.api.common.types.Voltage

compareTo(Object) - Method in class org.robokind.api.common.position.NormalizedDouble

compareTo(Object) - Method in class org.robokind.api.common.types.Temperature

compareTo(Object) - Method in class org.robokind.api.common.types.Voltage

complete(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

complete(long) - Method in interface org.robokind.api.common.playable.Playable

Stops the Playable, marking it complete.

ComplexAdapter<A,B,C> - Class in org.robokind.api.common.utils

ComplexAdapter(Adapter<A, B>, Adapter<B, C>) - Constructor for class org.robokind.api.common.utils.ComplexAdapter

CONFIG_CLASS - Static variable in class org.robokind.api.common.services.Constants

Property String for the Class of the ServiceConfig being loaded.

CONFIG_FORMAT_VERSION - Static variable in class org.robokind.api.common.services.Constants

Property String for the Configuration Format VersionProperty

CONFIG_PARAM_CLASS - Static variable in class org.robokind.api.common.services.Constants

Property String for the Parameter Class used by the ServiceConfigurationLoader and ServiceConfigurationWriter.

CONFIG_PARAM_ID - Static variable in class org.robokind.api.common.services.Constants

Property String for the id of a config loader parameter object.

ConfigurationAdapter<Service,Config> - Interface in org.robokind.api.common.services

Creates a Config object from a Service.

ConfigurationLoader<ServiceConfig,Param> - Interface in org.robokind.api.common.services

An ConfigurationLoader loads a ServiceConfig with a specific version.

ConfigurationWriter<ServiceConfig,Param> - Interface in org.robokind.api.common.services

ConfiguredServiceLifecycle<T,C,P> - Class in org.robokind.api.common.osgi.lifecycle

ConfiguredServiceLifecycle(ConfiguredServiceParams<T, C, P>) - Constructor for class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

Creates a lifecycle best fitting the given params.

ConfiguredServiceLifecycle(ConfiguredServiceParams<T, C, P>, Properties) - Constructor for class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

Creates a lifecycle best fitting the given params.

ConfiguredServiceParams<T,C,P> - Class in org.robokind.api.common.osgi.lifecycle

ConfiguredServiceParams(Class<T>, Class<C>, Class<P>, C, P, String, VersionProperty, VersionProperty) - Constructor for class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

Constants - Class in org.robokind.api.common.services

Constants() - Constructor for class org.robokind.api.common.services.Constants

convertToByteArray(List<Byte>) - Static method in class org.robokind.api.common.utils.Utils

Converts a List of Byte Objects to an array of byte primatives.

create(Map<String, Object>) - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

createConfig(Service) - Method in interface org.robokind.api.common.services.ConfigurationAdapter

createWriterServiceListener(BundleContext, Class<Conf>, Class<Param>, VersionProperty, String) - Static method in class org.robokind.api.common.services.ServiceUtils

D

deepCopy(List<Point2D>) - Static method in class org.robokind.api.common.utils.ListUtils

Returns a new List with a clone of each point from the list provided.

DEFAULT_RANGE - Static variable in class org.robokind.api.common.position.BooleanRange

DEFAULT_SPEECH_ID - Static variable in class org.robokind.api.common.utils.RKConstants

DefaultAddOnDriver<AddOn,Config> - Class in org.robokind.api.common.services.addon

DefaultAddOnDriver(BundleContext, VersionProperty, VersionProperty, ConfigurationAdapter<AddOn, Config>) - Constructor for class org.robokind.api.common.services.addon.DefaultAddOnDriver

denormalizeValue(NormalizedDouble) - Method in class org.robokind.api.common.position.BooleanRange

denormalizeValue(NormalizedDouble) - Method in class org.robokind.api.common.position.DoubleRange

denormalizeValue(NormalizedDouble) - Method in class org.robokind.api.common.position.IntegerRange

denormalizeValue(NormalizedDouble) - Method in class org.robokind.api.common.position.NormalizableRange.DefaultRange

denormalizeValue(NormalizedDouble) - Method in interface org.robokind.api.common.position.NormalizableRange

Denormalizes a NormalizedDouble to a value within this NormalizableRange.

display() - Method in class org.robokind.api.common.config.VersionProperty

Returns a string representing the version which is formatted for displaying.

DoubleRange - Class in org.robokind.api.common.position

Specifies a simple NormalizableRange of Numbers defined by a min and max.

DoubleRange(double, double) - Constructor for class org.robokind.api.common.position.DoubleRange

E

EmptyFactory<T> - Class in org.robokind.api.common.services

EmptyFactory(Class<T>, VersionProperty) - Constructor for class org.robokind.api.common.services.EmptyFactory

equals(Object) - Method in class org.robokind.api.common.config.VersionProperty

equals(Object) - Method in class org.robokind.api.common.position.NormalizedDouble

equals(Object) - Method in class org.robokind.api.common.types.Temperature

equals(Object) - Method in class org.robokind.api.common.types.Voltage

EventRepeater<Msg> - Class in org.robokind.api.common.utils

EventRepeater() - Constructor for class org.robokind.api.common.utils.EventRepeater

F

FileSystemAdapter - Interface in org.robokind.api.common.config

Defines a class which can open Files from a file system.

FileSystemAdapterImpl - Class in org.robokind.api.common.config

FileSystemAdapter implementation for reading from operating system's file system.

FileSystemAdapterImpl() - Constructor for class org.robokind.api.common.config.FileSystemAdapterImpl

filterType(List, Class<T>) - Static method in class org.robokind.api.common.utils.ListUtils

Returns the items in the given list which match the given class.

findConsecutiveSequences(Integer[]) - Static method in class org.robokind.api.common.utils.ListUtils

Takes an array of unsorted integers with no repeated values.

fireIndexedPropertyChange(String, int, Object, Object) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event for a property with an index.

fireIndexedPropertyChange(String, int, int, int) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event for a property with an index.

fireIndexedPropertyChange(String, int, boolean, boolean) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event for a property with an index.

firePlayStateChanged(PlayState, PlayState, long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Notifies listeners of a change in PlayState.

firePropertyChange(String, Object, Object) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event.

firePropertyChange(String, int, int) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event.

firePropertyChange(String, boolean, boolean) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event.

firePropertyChange(PropertyChangeEvent) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Fire a property change event using an existing PropertyChangeEvent.

G

get(String) - Method in class org.robokind.api.common.localization.LanguageLocale

Returns the localized value of the given key.

getAbbreviation() - Method in class org.robokind.api.common.localization.LanguageLocale

Returns the abbreviation of the language.

getAddOn() - Method in class org.robokind.api.common.services.addon.ServiceAddOn.DefaultAddOn

getAddOn() - Method in interface org.robokind.api.common.services.addon.ServiceAddOn

getAddOnDriver() - Method in class org.robokind.api.common.services.addon.ServiceAddOn.DefaultAddOn

getAddOnDriver() - Method in interface org.robokind.api.common.services.addon.ServiceAddOn

getAddOnDriverList(BundleContext, ServiceReference[]) - Static method in class org.robokind.api.common.services.addon.AddOnUtils

getAddOnDriverReferences(BundleContext, VersionProperty, VersionProperty) - Static method in class org.robokind.api.common.services.addon.AddOnUtils

getAddOnDriverReferences(BundleContext) - Static method in class org.robokind.api.common.services.addon.AddOnUtils

getConfig() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getConfigClass() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getConfigFormat() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getConfigFormat() - Method in class org.robokind.api.common.services.ServiceContext

getConfigLoaders(BundleContext, VersionProperty, Class<ServiceConfig>, Class<Param>) - Static method in class org.robokind.api.common.services.ServiceConnectionDirectory

Retrieves all ServiceConfigurationLoaders with the given Param Class, ServiceConfig Class, and Configuration Format Version.

getConfigurationClass() - Method in interface org.robokind.api.common.services.ConfigurationAdapter

getConfigurationClass() - Method in interface org.robokind.api.common.services.ConfigurationLoader

Returns the Class of the ServiceConfig to be loaded.

getConfigurationClass() - Method in interface org.robokind.api.common.services.ConfigurationWriter

Returns the Class of the ServiceConfig to write.

getConfigurationClass() - Method in class org.robokind.api.common.services.EmptyFactory

getConfigurationClass() - Method in class org.robokind.api.common.services.ServiceContext

getConfigurationClass() - Method in interface org.robokind.api.common.services.ServiceFactory

Returns the Class of ServiceConfig required to build to this type of Service.

getConfigurationFormat() - Method in class org.robokind.api.common.services.addon.DefaultAddOnDriver

getConfigurationFormat() - Method in interface org.robokind.api.common.services.addon.ServiceAddOnDriver

getConfigurationFormat() - Method in interface org.robokind.api.common.services.ConfigurationAdapter

getConfigurationFormat() - Method in interface org.robokind.api.common.services.ConfigurationLoader

Specifies the Service Configuration Format version which can be loaded.

getConfigurationFormat() - Method in interface org.robokind.api.common.services.ConfigurationWriter

Specifies the Service Configuration Format version to write.

getConfigWriters(BundleContext, VersionProperty, Class<ServiceConfig>, Class<Param>) - Static method in class org.robokind.api.common.services.ServiceConnectionDirectory

Finds ServiceConfigurationWriters matching the given criteria.

getDegreesCelsius() - Method in class org.robokind.api.common.types.Temperature

getElapsedPauseTime(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

getElapsedPauseTime(long) - Method in interface org.robokind.api.common.playable.Playable

Returns the elapsed time between the last pause time and the given time.

getElapsedPlayTime(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

getElapsedPlayTime(long) - Method in interface org.robokind.api.common.playable.Playable

Returns the elapsed time between the start time and the given time.

getEventType() - Method in class org.robokind.api.common.property.IndexedPropertyChangeAction

getEventType() - Method in class org.robokind.api.common.property.PropertyChangeAction

getEventType() - Method in class org.robokind.api.common.property.PropertyChangeActionBase

Returns the PropertyChangeEvent type accepted, T.

getIntervalLength() - Method in class org.robokind.api.common.utils.TimerLoop

Returns the interval length.

getKey(T) - Method in interface org.robokind.api.common.utils.PolymorphicAdapter.AdapterKeyMap

getLoadParameter() - Method in class org.robokind.api.common.services.ServiceContext

Returns the load parameter.

getLocale() - Method in class org.robokind.api.common.localization.LanguageLocale

Returns the name of the LanguageLocale.

getLocale() - Static method in class org.robokind.api.common.localization.Localizer

Returns the LanguageLocale being used.

getLocaleName() - Static method in class org.robokind.api.common.localization.Localizer

Returns the name of the current LanguageLocale.

getMax() - Method in class org.robokind.api.common.position.BooleanRange

getMax() - Method in class org.robokind.api.common.position.DoubleRange

getMax() - Method in class org.robokind.api.common.position.IntegerRange

getMax() - Method in class org.robokind.api.common.position.NormalizableRange.DefaultRange

getMax() - Method in interface org.robokind.api.common.position.NormalizableRange

Returns the minimum value of the NormalizableRange.

getMin() - Method in class org.robokind.api.common.position.BooleanRange

getMin() - Method in class org.robokind.api.common.position.DoubleRange

getMin() - Method in class org.robokind.api.common.position.IntegerRange

getMin() - Method in class org.robokind.api.common.position.NormalizableRange.DefaultRange

getMin() - Method in interface org.robokind.api.common.position.NormalizableRange

getName() - Method in class org.robokind.api.common.config.VersionProperty

Returns the version name.

getNumber() - Method in class org.robokind.api.common.config.VersionProperty

Returns the version number.

getParam() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getParamClass() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getParameterClass() - Method in interface org.robokind.api.common.services.ConfigurationLoader

Returns the Class of the Parameter required to load a ServiceConfig.

getParameterClass() - Method in interface org.robokind.api.common.services.ConfigurationWriter

Returns the Class of the Parameter required to write a ServiceConfig.

getParamId() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getPauseTime() - Method in class org.robokind.api.common.playable.AbstractPlayable

getPauseTime() - Method in interface org.robokind.api.common.playable.Playable

Returns the time given when the Playable was last paused.

getPlayState() - Method in class org.robokind.api.common.playable.AbstractPlayable

getPlayState() - Method in interface org.robokind.api.common.playable.Playable

Return the current PlayState of the Playable.

getPropertyChangeListeners() - Method in class org.robokind.api.common.property.PropertyChangeNotifier

getPropertyChangeListeners(String) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

getResumeTime() - Method in class org.robokind.api.common.playable.AbstractPlayable

getResumeTime() - Method in interface org.robokind.api.common.playable.Playable

Returns the time given when the Playable was last resumed.

getSerivceClass() - Method in interface org.robokind.api.common.services.ConfigurationAdapter

getService() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

getService() - Method in class org.robokind.api.common.services.ServiceContext

Returns the Service from this context.

getServiceClass() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

getServiceClass() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getServiceClass() - Method in class org.robokind.api.common.services.addon.DefaultAddOnDriver

getServiceClass() - Method in interface org.robokind.api.common.services.addon.ServiceAddOnDriver

getServiceClass() - Method in class org.robokind.api.common.services.EmptyFactory

getServiceClass() - Method in class org.robokind.api.common.services.ServiceContext

getServiceClass() - Method in interface org.robokind.api.common.services.ServiceFactory

Returns the Class of the Service connected to.

getServiceConfiguration() - Method in class org.robokind.api.common.services.ServiceContext

Returns the ServiceConfig loaded from the LoadParameter.

getServiceConfigurationLoader() - Method in class org.robokind.api.common.services.ServiceContext

Returns the ConfigurationLoader for this ServiceContext.

getServiceFactories(BundleContext, VersionProperty, Class<ServiceClass>) - Static method in class org.robokind.api.common.services.ServiceConnectionDirectory

Retrieves all ServiceFactories with the given ServiceClass and Service Version.

getServiceFactory() - Method in class org.robokind.api.common.services.ServiceContext

Return the ServiceFactory used by this ServiceContext.

getServiceVersion() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceParams

getServiceVersion() - Method in class org.robokind.api.common.services.addon.DefaultAddOnDriver

getServiceVersion() - Method in interface org.robokind.api.common.services.addon.ServiceAddOnDriver

getServiceVersion() - Method in interface org.robokind.api.common.services.ConfigurationAdapter

getServiceVersion() - Method in class org.robokind.api.common.services.EmptyFactory

getServiceVersion() - Method in class org.robokind.api.common.services.ServiceContext

getServiceVersion() - Method in interface org.robokind.api.common.services.ServiceFactory

Returns the VersionProperty of the Service this connects to.

getStartTime() - Method in class org.robokind.api.common.playable.AbstractPlayable

getStartTime() - Method in interface org.robokind.api.common.playable.Playable

Returns the time given when the Playable was started.

getStopTime() - Method in class org.robokind.api.common.playable.AbstractPlayable

getStopTime() - Method in interface org.robokind.api.common.playable.Playable

Returns the time given when the Playable was last stopped.

getSwingFlag() - Static method in class org.robokind.api.common.property.PropertyChangeUtils

Returns the Swing flag value

getValue() - Method in class org.robokind.api.common.position.NormalizedDouble

Returns the value of the NormalizeRange.

getValue() - Method in class org.robokind.api.common.utils.RKSource.SourceImpl

getVolts() - Method in class org.robokind.api.common.types.Voltage

H

handleChange(String, Object, Map<String, Object>) - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

handleEvent(Msg) - Method in class org.robokind.api.common.utils.EventRepeater

hashCode() - Method in class org.robokind.api.common.config.VersionProperty

hashCode() - Method in class org.robokind.api.common.position.NormalizedDouble

hashCode() - Method in class org.robokind.api.common.types.Temperature

hashCode() - Method in class org.robokind.api.common.types.Voltage

hasListeners(String) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

I

IndexedPropertyChangeAction - Class in org.robokind.api.common.property

PropertyChangeAction for an indexed property

IndexedPropertyChangeAction() - Constructor for class org.robokind.api.common.property.IndexedPropertyChangeAction

IntegerRange - Class in org.robokind.api.common.position

Specifies a simple NormalizableRange of Numbers defined by a min and max.

IntegerRange(int, int) - Constructor for class org.robokind.api.common.position.IntegerRange

isValid(Boolean) - Method in class org.robokind.api.common.position.BooleanRange

isValid(Double) - Method in class org.robokind.api.common.position.DoubleRange

isValid(Integer) - Method in class org.robokind.api.common.position.IntegerRange

isValid(NormalizedDouble) - Method in class org.robokind.api.common.position.NormalizableRange.DefaultRange

isValid(T) - Method in interface org.robokind.api.common.position.NormalizableRange

Returns true if t is within the NormalizableRange.

isValid(double) - Static method in class org.robokind.api.common.position.NormalizedDouble

Returns true if the given value can be used to create a NormalizedDouble.

L

LanguageLocale - Class in org.robokind.api.common.localization

A class for localizing String to a certain language.

LanguageLocale(String, String, Map<String, String>) - Constructor for class org.robokind.api.common.localization.LanguageLocale

Creates a new LanguageLocale.

ListenerConstants - Class in org.robokind.api.common.utils

Listens for events of type T.

ListenerConstants() - Constructor for class org.robokind.api.common.utils.ListenerConstants

ListUtils - Class in org.robokind.api.common.utils

Utility methods for working with Lists.

ListUtils() - Constructor for class org.robokind.api.common.utils.ListUtils

loadAddOn(File) - Method in class org.robokind.api.common.services.addon.DefaultAddOnDriver

loadAddOn(File) - Method in interface org.robokind.api.common.services.addon.ServiceAddOnDriver

loadConfiguration(Param) - Method in interface org.robokind.api.common.services.ConfigurationLoader

Loads a ServiceConfig of the specified type from the given parameters.

loadConfiguration() - Method in class org.robokind.api.common.services.ServiceContext

Loads the ServiceConfig using the ConfigurationLoader and LoadParameter.

localize(String) - Static method in class org.robokind.api.common.localization.Localizer

Returns the localized value for the given key.

Localizer - Class in org.robokind.api.common.localization

Static methods for language localization.

Localizer() - Constructor for class org.robokind.api.common.localization.Localizer

M

mergeMaps(Map<K, V>, Map<K, V>...) - Static method in class org.robokind.api.common.utils.Utils

Adds the values from src to dest where the key from src does not exist in dest.

myElapsedPauseTime - Variable in class org.robokind.api.common.playable.AbstractPlayable

The total elapsed time while paused.

myPauseTime - Variable in class org.robokind.api.common.playable.AbstractPlayable

The time given when last being paused.

myPlayableListeners - Variable in class org.robokind.api.common.playable.AbstractPlayable

Listeners for PlayState changes

myPlayState - Variable in class org.robokind.api.common.playable.AbstractPlayable

The current PlayState.

myPropertyActions - Variable in class org.robokind.api.common.property.PropertyChangeMonitor

A map associating PropertyChangeActions with an event name.

myResumeTime - Variable in class org.robokind.api.common.playable.AbstractPlayable

The time given when last being resumed.

myServiceContext - Variable in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

ServiceContext created from loading a service.

myStartTime - Variable in class org.robokind.api.common.playable.AbstractPlayable

The time given when starting.

myStopTime - Variable in class org.robokind.api.common.playable.AbstractPlayable

The time given when last being stopped.

N

NormalizableRange<T> - Interface in org.robokind.api.common.position

NormalizableRange.DefaultRange - Class in org.robokind.api.common.position

Returns the maximum value of the NormalizableRange.

NormalizableRange.DefaultRange() - Constructor for class org.robokind.api.common.position.NormalizableRange.DefaultRange

NORMALIZED_RANGE - Static variable in interface org.robokind.api.common.position.NormalizableRange

NormalizedDouble - Class in org.robokind.api.common.position

NormalizedDouble is a value normalized to the range of [0.0, 1.0] (0.0 <= val <= 1.0).

NormalizedDouble(double) - Constructor for class org.robokind.api.common.position.NormalizedDouble

Creates a new NormalizedDouble with the given value

normalizeValue(Boolean) - Method in class org.robokind.api.common.position.BooleanRange

normalizeValue(Double) - Method in class org.robokind.api.common.position.DoubleRange

normalizeValue(Integer) - Method in class org.robokind.api.common.position.IntegerRange

normalizeValue(NormalizedDouble) - Method in class org.robokind.api.common.position.NormalizableRange.DefaultRange

normalizeValue(T) - Method in interface org.robokind.api.common.position.NormalizableRange

Normalizes a value within the NormalizableRange.

now() - Static method in class org.robokind.api.common.utils.TimeUtils

Returns the current clock time.

O

onComplete(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Called when the Playable is completed

onPause(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Called when the Playable is paused

onResume(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Called when the Playable is resumed

onStart(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Called when the Playable is started.

onStop(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

Called when the Playable is stopped

openFile(String) - Method in interface org.robokind.api.common.config.FileSystemAdapter

Opens the file at the given path.

openFile(String) - Method in class org.robokind.api.common.config.FileSystemAdapterImpl

openImageIcon(String) - Method in interface org.robokind.api.common.config.FileSystemAdapter

Opens the icon at the given path.

openImageIcon(String) - Method in class org.robokind.api.common.config.FileSystemAdapterImpl

org.robokind.api.common.config - package org.robokind.api.common.config

org.robokind.api.common.localization - package org.robokind.api.common.localization

org.robokind.api.common.osgi.lifecycle - package org.robokind.api.common.osgi.lifecycle

org.robokind.api.common.playable - package org.robokind.api.common.playable

org.robokind.api.common.position - package org.robokind.api.common.position

org.robokind.api.common.property - package org.robokind.api.common.property

org.robokind.api.common.services - package org.robokind.api.common.services

org.robokind.api.common.services.addon - package org.robokind.api.common.services.addon

org.robokind.api.common.types - package org.robokind.api.common.types

org.robokind.api.common.utils - package org.robokind.api.common.utils

P

parseFloats(String...) - Static method in class org.robokind.api.common.utils.ListUtils

Returns an array of floats parsed from the given strings.

pause(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

pause(long) - Method in interface org.robokind.api.common.playable.Playable

Pauses the Playable in its current state.

performAction(PropertyChangeEvent) - Method in class org.robokind.api.common.property.PropertyChangeActionBase

Performs the action with the given event only if the event is an instance of T

PHYSICAL_R50_ID - Static variable in class org.robokind.api.common.utils.RKConstants

Playable - Interface in org.robokind.api.common.playable

An interface defining standard play controls: start, pause, resume, and stop.

PlayableListener - Interface in org.robokind.api.common.playable

An interface for classes which listen to a Playable.

PlayState - Enum in org.robokind.api.common.playable

States of a Playable.

playStateChanged(PlayState, PlayState, long) - Method in interface org.robokind.api.common.playable.PlayableListener

Fired when the PlayState of a Playable changes

PolymorphicAdapter<A,B> - Class in org.robokind.api.common.utils

PolymorphicAdapter(PolymorphicAdapter.AdapterKeyMap<A>) - Constructor for class org.robokind.api.common.utils.PolymorphicAdapter

PolymorphicAdapter.AdapterKeyMap<T> - Interface in org.robokind.api.common.utils

PositionMap<Identifier,Position> - Interface in org.robokind.api.common.position

PositionMap is a Map of an Identifier type to a Position type.

PositionMap.HashMap<Id,Pos> - Class in org.robokind.api.common.position

PositionMap.HashMap<Id, Pos> is a java.util.HashMap<Id, Pos>

PositionMap.HashMap() - Constructor for class org.robokind.api.common.position.PositionMap.HashMap

PROP_LISTENER_ID - Static variable in class org.robokind.api.common.utils.ListenerConstants

PROP_LISTENER_TYPE - Static variable in class org.robokind.api.common.utils.ListenerConstants

PROP_NAME - Static variable in class org.robokind.api.common.config.VersionProperty

Property String for version name.

PROP_NUMBER - Static variable in class org.robokind.api.common.config.VersionProperty

Property String for version number.

propertyChange(PropertyChangeEvent) - Method in class org.robokind.api.common.property.PropertyChangeMonitor

Fires all actions associated with the name of the given event.

PropertyChangeAction - Class in org.robokind.api.common.property

PropertyChangeAction for a standard PropertyChangeEvent

PropertyChangeAction() - Constructor for class org.robokind.api.common.property.PropertyChangeAction

PropertyChangeActionBase<T extends PropertyChangeEvent> - Class in org.robokind.api.common.property

Base class for PropertyChangeActions to use with a PropertyChangeMonitor

PropertyChangeActionBase() - Constructor for class org.robokind.api.common.property.PropertyChangeActionBase

PropertyChangeMonitor - Class in org.robokind.api.common.property

A support class for listening to PropertyChangeEvents.

PropertyChangeMonitor() - Constructor for class org.robokind.api.common.property.PropertyChangeMonitor

PropertyChangeNotifier - Class in org.robokind.api.common.property

An implementation of PropertyChangeSource with helper methods for firing events.

PropertyChangeNotifier(PropertyChangeSupport) - Constructor for class org.robokind.api.common.property.PropertyChangeNotifier

Creates a PropertyChangeNotifier with the given PropertyChangeSupport.

PropertyChangeNotifier(Object) - Constructor for class org.robokind.api.common.property.PropertyChangeNotifier

Creates a new PropertyChangeNotifier with a new PropertyChangeSupport made from sourceBean.

PropertyChangeNotifier() - Constructor for class org.robokind.api.common.property.PropertyChangeNotifier

Creates a new PropertyChangeNotifier with a new PropertyChangeSupport.

PropertyChangeSource - Interface in org.robokind.api.common.property

Interface defining methods for Classes which fire property change events.

PropertyChangeUtils - Class in org.robokind.api.common.property

Helper methods for PropertyChangeSupport

PropertyChangeUtils() - Constructor for class org.robokind.api.common.property.PropertyChangeUtils

R

rangeCheck(double) - Method in class org.robokind.api.common.position.NormalizedDouble

Checks that the value is within the range [0.0, 1.0].

readHex(String) - Static method in class org.robokind.api.common.utils.Utils

Returns the decimal value of a two character hex string.

readHex(char) - Static method in class org.robokind.api.common.utils.Utils

Converts the characters '0'-'9' (48-58), 'A'-'F' (65-70), and 'a'-'f' (32-37) or to the decimal value of their corresponding hex values.

registerAddOnDriver(BundleContext, ServiceAddOnDriver, Properties) - Static method in class org.robokind.api.common.services.addon.AddOnUtils

registerConfigLoader(BundleContext, ConfigurationLoader) - Static method in class org.robokind.api.common.services.ServiceUtils

registerConfigLoader(BundleContext, ConfigurationLoader, Properties) - Static method in class org.robokind.api.common.services.ServiceUtils

registerConfigWriter(BundleContext, ConfigurationWriter) - Static method in class org.robokind.api.common.services.ServiceUtils

registerConfigWriter(BundleContext, ConfigurationWriter, Properties) - Static method in class org.robokind.api.common.services.ServiceUtils

registerFactory(BundleContext, ServiceFactory) - Static method in class org.robokind.api.common.services.ServiceUtils

Registers the given ServiceFactory with the factory's Service Version, Service class, and Config class.

registerFactory(BundleContext, ServiceFactory, Properties) - Static method in class org.robokind.api.common.services.ServiceUtils

releaseAddOnDrivers(BundleContext, ServiceReference[]) - Static method in class org.robokind.api.common.services.addon.AddOnUtils

removeListener(Listener<Msg>) - Method in class org.robokind.api.common.utils.EventRepeater

removePlayableListener(PlayableListener) - Method in class org.robokind.api.common.playable.AbstractPlayable

removePlayableListener(PlayableListener) - Method in interface org.robokind.api.common.playable.Playable

Removes a PlayableListener from being notified

removePropertyChangeListener(PropertyChangeListener) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Removes a PropertyChangeListener from the PropertyChangeSupport.

removePropertyChangeListener(String, PropertyChangeListener) - Method in class org.robokind.api.common.property.PropertyChangeNotifier

Removes a PropertyChangeListener from the PropertyChangeSupport from listening to a specific event.

removePropertyChangeListener(PropertyChangeListener) - Method in interface org.robokind.api.common.property.PropertyChangeSource

Removes a listener

removePropertyChangeListener(String, PropertyChangeListener) - Method in interface org.robokind.api.common.property.PropertyChangeSource

Removes a listener from listening to a specific property change event.

resume(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

resume(long) - Method in interface org.robokind.api.common.playable.Playable

Resumes a paused Playable.

RKConstants - Class in org.robokind.api.common.utils

RKConstants() - Constructor for class org.robokind.api.common.utils.RKConstants

RKSource<T> - Interface in org.robokind.api.common.utils

Defines a class which can get and set an object of the specified type.

RKSource.SourceImpl<T> - Class in org.robokind.api.common.utils

Generic Source implementation.

RKSource.SourceImpl() - Constructor for class org.robokind.api.common.utils.RKSource.SourceImpl

Creates a new SourceImpl with a null value.

RKSource.SourceImpl(T) - Constructor for class org.robokind.api.common.utils.RKSource.SourceImpl

Creates a new SourceImpl with the given value.

run(T) - Method in class org.robokind.api.common.property.PropertyChangeActionBase

Action to perform when a PropertyChangeEvent of type T is found

S

saveAddOnConfig(ServiceAddOn, String) - Static method in class org.robokind.api.common.services.addon.AddOnUtils

SERVICE_CLASS - Static variable in class org.robokind.api.common.services.Constants

Property String for the Class of the Service connected to.

SERVICE_VERSION - Static variable in class org.robokind.api.common.services.Constants

Property String for the Service VersionProperty.

ServiceAddOn<AddOn> - Interface in org.robokind.api.common.services.addon

ServiceAddOn.DefaultAddOn<AddOn> - Class in org.robokind.api.common.services.addon

ServiceAddOn.DefaultAddOn(AddOn, ServiceAddOnDriver<AddOn>) - Constructor for class org.robokind.api.common.services.addon.ServiceAddOn.DefaultAddOn

ServiceAddOnDriver<AddOn> - Interface in org.robokind.api.common.services.addon

ServiceConnectionDirectory - Class in org.robokind.api.common.services

The ServiceConnectionDirectory helps locate the proper ConfigurationLoader and ServiceFactory to build the right Service from the given parameters.

ServiceConnectionDirectory() - Constructor for class org.robokind.api.common.services.ServiceConnectionDirectory

ServiceContext<ServiceClass,ServiceConfig,Param> - Class in org.robokind.api.common.services

An ServiceContext keeps track of an attempt to create a new Service.

ServiceContext() - Constructor for class org.robokind.api.common.services.ServiceContext

Creates an empty ServiceContext

ServiceContext(ConfigurationLoader<ServiceConfig, Param>, ServiceFactory<ServiceClass, ServiceConfig>) - Constructor for class org.robokind.api.common.services.ServiceContext

Creates a new ServiceContext from the given ConfigurationLoader and ServiceFactory.

ServiceFactory<ServiceClass,ServiceConfig> - Interface in org.robokind.api.common.services

A ServiceFactory creates some service with the given Class and the given VersionProperty, using a ServiceConfig

ServiceUtils - Class in org.robokind.api.common.services

ServiceUtils() - Constructor for class org.robokind.api.common.services.ServiceUtils

set(T) - Method in interface org.robokind.api.common.utils.RKSource

Set the object value.

set(T) - Method in class org.robokind.api.common.utils.RKSource.SourceImpl

setIntervalLength(long) - Method in class org.robokind.api.common.utils.TimerLoop

Sets the interval length.

setLoadParameter(Param) - Method in class org.robokind.api.common.services.ServiceContext

Sets the load parameter.

setLocale(LanguageLocale) - Static method in class org.robokind.api.common.localization.Localizer

Sets the LanguageLocale to use for localization.

setName(String) - Method in class org.robokind.api.common.config.VersionProperty

Set the version name

setNumber(String) - Method in class org.robokind.api.common.config.VersionProperty

Set the version number

setServiceConfiguration(ServiceConfig) - Method in class org.robokind.api.common.services.ServiceContext

Sets the ServiceConfig to use instead of loading a config.

setServiceConfigurationLoader(ConfigurationLoader<ServiceConfig, Param>) - Method in class org.robokind.api.common.services.ServiceContext

Sets the ConfigurationLoader for this ServiceContext.

setServiceFactory(ServiceFactory<ServiceClass, ServiceConfig>) - Method in class org.robokind.api.common.services.ServiceContext

Sets the ServiceFactory to be used by this ServiceContext.

setSwing(boolean) - Static method in class org.robokind.api.common.property.PropertyChangeUtils

Sets the Swing flag.

sleep(long) - Static method in class org.robokind.api.common.utils.TimeUtils

Attempts to sleep for the specified length

start(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

start(long) - Method in interface org.robokind.api.common.playable.Playable

Starts the Playable from its initial state.

start() - Method in class org.robokind.api.common.utils.TimerLoop

Start performing the action at intervals.

stop() - Method in class org.robokind.api.common.osgi.lifecycle.ConfiguredServiceLifecycle

stop(long) - Method in class org.robokind.api.common.playable.AbstractPlayable

stop(long) - Method in interface org.robokind.api.common.playable.Playable

Stops a Playable, returning to the initial state.

stop() - Method in class org.robokind.api.common.utils.TimerLoop

Stop the timer.

T

Temperature - Class in org.robokind.api.common.types

Temperature(double) - Constructor for class org.robokind.api.common.types.Temperature

TimerLoop - Class in org.robokind.api.common.utils

Abstract class for performing an action at regular intervals.

TimerLoop(long) - Constructor for class org.robokind.api.common.utils.TimerLoop

Creates a new TimerLoop with the given interval in milliseconds.

timerTick(long, long) - Method in class org.robokind.api.common.utils.TimerLoop

Action to perform at regular intervals.

timeString(long) - Static method in class org.robokind.api.common.utils.TimeUtils

Formats a timespan in milliseconds

timeString(long, int) - Static method in class org.robokind.api.common.utils.TimeUtils

Formats a timespan in milliseconds

TimeUtils - Class in org.robokind.api.common.utils

Utility methods for dealing with time.

TimeUtils() - Constructor for class org.robokind.api.common.utils.TimeUtils

toString() - Method in class org.robokind.api.common.config.VersionProperty

toString() - Method in class org.robokind.api.common.position.NormalizedDouble

toString() - Method in class org.robokind.api.common.types.Temperature

toString() - Method in class org.robokind.api.common.types.Voltage

U

unsign(byte) - Static method in class org.robokind.api.common.utils.Utils

Returns the unsigned value of the given signed byte.

Utils - Class in org.robokind.api.common.utils

Miscellaneous utility methods.

Utils() - Constructor for class org.robokind.api.common.utils.Utils

V

valueOf(String) - Static method in enum org.robokind.api.common.playable.PlayState

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.robokind.api.common.playable.PlayState

Returns an array containing the constants of this enum type, in the order they are declared.

VersionProperty - Class in org.robokind.api.common.config

Defines a version.

VersionProperty(String, String) - Constructor for class org.robokind.api.common.config.VersionProperty

Creates a new VersionPropety with the given name and number.

VIRTUAL_R50_ID - Static variable in class org.robokind.api.common.utils.RKConstants

Voltage - Class in org.robokind.api.common.types

Voltage(double) - Constructor for class org.robokind.api.common.types.Voltage

W

writeConfiguration(ServiceConfig, Param) - Method in interface org.robokind.api.common.services.ConfigurationWriter

Writes a ServiceConfig of the specified type using the given parameters.

writeServiceConfig(AddOn, File) - Method in class org.robokind.api.common.services.addon.DefaultAddOnDriver

writeServiceConfig(AddOn, File) - Method in interface org.robokind.api.common.services.addon.ServiceAddOnDriver

_

_$(String) - Static method in class org.robokind.api.common.localization.Localizer

Return the String associated with the given key proceeded with a space: ' '.

_$_(String) - Static method in class org.robokind.api.common.localization.Localizer

Return the String associated with the given key surrounded with spaces: ' '.

$ A B C D E F G H I L M N O P R S T U V W _