Package com.yetanalytics.xapi.model

Class LangMap

java.lang.Object

com.yetanalytics.xapi.model.LangMap

All Implemented Interfaces:

IFreeMap<LangTag,String>, JSONObject, Serializable

public class LangMap
extends Object
implements IFreeMap<LangTag,String>, JSONObject

Java wrapper object for the xAPI Language Map object. The Language Map is a dictionary where the keys are RFC 5646 Language Tags and the value is a String in the language specified by the tag.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LangMap(HashMap<LangTag,String> input)	Create a new langmap from a HashMap

Method Summary

Modifier and Type	Method	Description
String	get(LangTag languageCode)	Retrieve the value for a specific language.
String	get(String languageCode)	Retrieve the value for a specific language.
Set<LangTag>	getKeys()	Retrieves the full set of RFC 5646 Language Tags contained in the Map
Map<LangTag,String>	getMap()	Retrieves the full Language Map in the form of a HashMap<String, String>
@jakarta.validation.constraints.AssertFalse(message="Language Map must not be empty") boolean	isEmpty()
void	put(LangTag languageCode, String value)	Sets an entry in the Language Map
void	put(String languageCode, String value)	Sets an entry in the Language Map
void	remove(LangTag languageCode)	Remove an entry from the Language Map
void	remove(String languageCode)	Remove an entry from the Language Map

Methods inherited from class java.lang.Object

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

Constructor Detail

LangMap

public LangMap(HashMap<LangTag,String> input)

Create a new langmap from a HashMap

Parameters:

input - a HashMap of RFC5646 Language Tags, and corresponding value strings

Method Detail

put

public void put(LangTag languageCode,
                String value)

Sets an entry in the Language Map

Specified by:

put in interface IFreeMap<LangTag,String>

Parameters:

languageCode - the RFC 5646 LangTag of the specified Language

value - a string in the language specified by languageCode

put

public void put(String languageCode,
                String value)
         throws IllformedLocaleException

Sets an entry in the Language Map

Specified by:

put in interface IFreeMap<LangTag,String>

Parameters:

languageCode - the RFC 5646 language tag String of the specified language

value - a string in the language specified by languageCode

Throws:

IllformedLocaleException

get

public String get(LangTag languageCode)

Retrieve the value for a specific language.

Specified by:

get in interface IFreeMap<LangTag,String>

Parameters:

languageCode - RFC 5646 LangTag

Returns:

The value in the language specified by the tag.

get

public String get(String languageCode)
           throws IllformedLocaleException

Retrieve the value for a specific language.

Specified by:

get in interface IFreeMap<LangTag,String>

Parameters:

languageCode - RFC 5646 language tag String

Returns:

The value in the language specified by the tag

Throws:

IllformedLocaleException

remove

public void remove(LangTag languageCode)

Remove an entry from the Language Map

Specified by:

remove in interface IFreeMap<LangTag,String>

Parameters:

languageCode - RFC 5646 LangTag

remove

public void remove(String languageCode)
            throws IllformedLocaleException

Remove an entry from the Language Map

Specified by:

remove in interface IFreeMap<LangTag,String>

Parameters:

languageCode - RFC 5646 language tag String

Throws:

IllformedLocaleException

getKeys

public Set<LangTag> getKeys()

Retrieves the full set of RFC 5646 Language Tags contained in the Map

Specified by:

getKeys in interface IFreeMap<LangTag,String>

Returns:

A set of RFC 5646 LangTag instances

getMap

public Map<LangTag,String> getMap()

Retrieves the full Language Map in the form of a HashMap<String, String>

Specified by:

getMap in interface IFreeMap<LangTag,String>

Returns:

The full Language Map

isEmpty

@AssertFalse(message="Language Map must not be empty")
public @jakarta.validation.constraints.AssertFalse(message="Language Map must not be empty") boolean isEmpty()

Specified by:

isEmpty in interface JSONObject