com.kuka.roboticsAPI.persistenceModel
Class TemplateAddInfoHelper

java.lang.Object
  com.kuka.roboticsAPI.persistenceModel.TemplateAddInfoHelper

public final class TemplateAddInfoHelper
extends Object

Helper class for template additional informations.

Method Summary

static InfoTemplate	getAddInfoTemplate(AdditionalInformation infos, String key) Gets an InfoTemplate from the additional information.
static InfoTemplate	getAddInfoTemplate(AdditionalInformation infos, String key, String typeName) Gets an InfoTemplate from the additional information.
static String	getAddInfoValue(AdditionalInformation infos, String key) Reads a value from the additional information.
static String	getAddInfoValue(AdditionalInformation infos, String key, String typeName) Reads a value from the additional information.
static List<String>	getAddInfoValues(AdditionalInformation infos, String key) Reads multiple values from the additional information.
static List<String>	getAddInfoValues(AdditionalInformation infos, String key, String typeName) Reads multiple values from the additional information.
static void	removeAddInfo(FrameTemplate element, String key) Removes an additional information.
static void	removeAddInfo(FrameTemplate element, String key, String typeName) Removes an additional information.
static void	removeAddInfo(TemplateElement element, String key) Removes an additional information.
static void	removeAddInfo(TemplateElement element, String key, String typeName) Removes an additional information.
static void	setAddInfoValue(FrameTemplate element, String key, String typeName, String value) Sets an additional information value.
static void	setAddInfoValue(TemplateElement element, String key, String typeName, Collection<String> values) Sets multiple additional information values.
static void	setAddInfoValue(TemplateElement element, String key, String typeName, String value) Sets an additional information value.

Methods inherited from class java.lang.Object

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

Method Detail

getAddInfoValue

public static String getAddInfoValue(AdditionalInformation infos,
                                     String key)

Reads a value from the additional information.

Parameters:

infos - additional information list

key - key of the additional info

Returns:

value of the additional info when present, otherwise null

getAddInfoValues

public static List<String> getAddInfoValues(AdditionalInformation infos,
                                            String key)

Reads multiple values from the additional information.

Parameters:

infos - additional information list

key - key of the additional info

Returns:

values of the additional info when present, otherwise null

getAddInfoValue

public static String getAddInfoValue(AdditionalInformation infos,
                                     String key,
                                     String typeName)

Reads a value from the additional information.

Parameters:

infos - additional information list

key - key of the additional info

typeName - additional info type name

Returns:

value of the additional info when present, otherwise null

getAddInfoValues

public static List<String> getAddInfoValues(AdditionalInformation infos,
                                            String key,
                                            String typeName)

Reads multiple values from the additional information.

Parameters:

infos - additional information list

key - key of the additional info

typeName - additional info type name

Returns:

values of the additional info when present, otherwise null

getAddInfoTemplate

public static InfoTemplate getAddInfoTemplate(AdditionalInformation infos,
                                              String key)

Gets an InfoTemplate from the additional information.

Parameters:

infos - additional information list

key - key of the additional info

Returns:

InfoTemplate when found, otherwise null

getAddInfoTemplate

public static InfoTemplate getAddInfoTemplate(AdditionalInformation infos,
                                              String key,
                                              String typeName)

Gets an InfoTemplate from the additional information.

Parameters:

infos - additional information list

key - key of the additional info

typeName - additional info type name

Returns:

InfoTemplate when found, otherwise null

removeAddInfo

public static void removeAddInfo(TemplateElement element,
                                 String key)

Removes an additional information.

Parameters:

element - Element containing the additional information

key - key of the additional information

removeAddInfo

public static void removeAddInfo(TemplateElement element,
                                 String key,
                                 String typeName)

Removes an additional information.

Parameters:

element - Element containing the additional information

key - key of the additional information

typeName - additional info type name

removeAddInfo

public static void removeAddInfo(FrameTemplate element,
                                 String key)

Removes an additional information.

Parameters:

element - Element containing the additional information

key - key of the additional information

removeAddInfo

public static void removeAddInfo(FrameTemplate element,
                                 String key,
                                 String typeName)

Removes an additional information.

Parameters:

element - Element containing the additional information

key - key of the additional information

typeName - additional info type name

setAddInfoValue

public static void setAddInfoValue(TemplateElement element,
                                   String key,
                                   String typeName,
                                   String value)

Sets an additional information value.

Parameters:

element - Element containing the additional information

key - key of the additional information

typeName - additional info type name

value - value to set, set to null to remove the additional info

setAddInfoValue

public static void setAddInfoValue(TemplateElement element,
                                   String key,
                                   String typeName,
                                   Collection<String> values)

Sets multiple additional information values.

Parameters:

element - Element containing the additional information

key - key of the additional information

typeName - additional info type name

values - values to set, set to null or empty collection to remove the additional info

setAddInfoValue

public static void setAddInfoValue(FrameTemplate element,
                                   String key,
                                   String typeName,
                                   String value)

Sets an additional information value.

Parameters:

element - Element containing the additional information

key - key of the additional information

typeName - additional info type name

value - value to set, set to null to remove the additional info