org.robotframework.javalib.keyword
Class KeywordMap

java.lang.Object
  org.robotframework.javalib.keyword.KeywordMap

public class KeywordMap
extends java.lang.Object

A data structure for keywords and related values, such as instances or class names. Keyword names must be unique after normalization. Names and values have to be non null.

Author:

Sami Honkonen

Constructor Summary

KeywordMap()

Method Summary

void	add(java.lang.String keywordName, java.lang.Object value) Adds a keyword to the map.
boolean	containsKeyword(java.lang.String keywordName) Checks whether map contains a pair with given keyword name
java.lang.Object	get(java.lang.String keywordName) Gets the value associated with given keyword name.
java.lang.String[]	getKeywordNames() Returns the keyword names.
protected java.util.Map	getUnderlyingMap() Returns the underlying Map instance.
static java.lang.String	normalizeKeywordName(java.lang.String keywordName) Normalizes a keyword name.
int	size() Amount of pairs in map

Methods inherited from class java.lang.Object

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

Constructor Detail

KeywordMap

public KeywordMap()

Method Detail

add

public void add(java.lang.String keywordName,
                java.lang.Object value)

Adds a keyword to the map. Name will be normalized.

Parameters:

keywordName - name to be added

value - associated value

get

public java.lang.Object get(java.lang.String keywordName)

Gets the value associated with given keyword name. Keyword name is normalized before searching.

Parameters:

keywordName - keyword name

Returns:

associated value

normalizeKeywordName

public static java.lang.String normalizeKeywordName(java.lang.String keywordName)

Normalizes a keyword name. Removes spaces and special characters. Converts all letters to lower case.

Parameters:

keywordName - keyword name

Returns:

normalized keyword name

size

public int size()

Amount of pairs in map

Returns:

amount of pairs in map

getKeywordNames

public java.lang.String[] getKeywordNames()

Returns the keyword names. Similar to Map.keySet().

Returns:

array of keyword names

containsKeyword

public boolean containsKeyword(java.lang.String keywordName)

Checks whether map contains a pair with given keyword name

Parameters:

keywordName - keyword name

Returns:

true if pair exists, false otherwise

getUnderlyingMap

protected java.util.Map getUnderlyingMap()

Returns the underlying Map instance.

Returns:

underlying predicated HashedMap