com.prosysopc.ua.stack.builtintypes

Class LocalizedText.Builder

java.lang.Object

com.prosysopc.ua.stack.builtintypes.LocalizedText.Builder

Enclosing class:

LocalizedText

public static final class LocalizedText.Builder
extends Object

Builder for LocalizedText. This class is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
LocalizedText	build() Builds a LocalizedText based on the current getTexts() data.
Map<String,String>	getTexts() Returns a view to the current texts.
LocalizedText.Builder	removeAll() Removes all texts.
LocalizedText.Builder	removeText(Locale locale) Removes text for given locale.
LocalizedText.Builder	removeText(String localeId) Removes text for given locale.
LocalizedText.Builder	setDefaultText(String text) Sets the text for the default locale.
LocalizedText.Builder	setText(String text, Locale locale) Sets the text for the given locale.
LocalizedText.Builder	setText(String text, String localeId) Sets the text for the given locale.
LocalizedText.Builder	setTexts(LocalizedText localizedText) Sets all texts from the given LocalizedText to this LocalizedText.Builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public LocalizedText build()

Builds a LocalizedText based on the current getTexts() data. Throws IllegalStateException if somehow a null locale or null text (use empty String instead) has been set (e.g. by modifying getTexts() output directly). If no texts are set, returns LocalizedText.EMPTY.

getTexts

public Map<String,String> getTexts()

Returns a view to the current texts. The Map keys are the LocaleIds and the values texts in that locale. An empty key is used for the default locale (i.e. "invariant locale").

Modifications to the returned map modifies this Builder. Note that null keys and values are not permitted. OPC UA LocalizedText considers null and empty to be the same and they are binary-encoded as "not present", here empty String is used to indicate "not present". If a null key or value has been set to the map, the build() will throw an IllegalStateException.

removeAll

public LocalizedText.Builder removeAll()

Removes all texts.

removeText

public LocalizedText.Builder removeText(Locale locale)

Removes text for given locale.

removeText

public LocalizedText.Builder removeText(String localeId)

Removes text for given locale.

setDefaultText

public LocalizedText.Builder setDefaultText(String text)

Sets the text for the default locale. This is same as calling setText(String, String) with empty localeId.

setText

public LocalizedText.Builder setText(String text,
                                     Locale locale)

Sets the text for the given locale.

setText

public LocalizedText.Builder setText(String text,
                                     String localeId)

Sets the text for the given locale.

setTexts

public LocalizedText.Builder setTexts(LocalizedText localizedText)

Sets all texts from the given LocalizedText to this LocalizedText.Builder. This behaves the same as calling Map.putAll(Map) for getTexts() using the LocalizedText.getTexts() from the given LocalizedText. A given null value behaves the same as-if LocalizedText.EMPTY would have been given.