de.aristaflow.adept2.model.common.i18n

Class LocalisedStringCollection

java.lang.Object

de.aristaflow.adept2.model.common.i18n.LocalisedStringCollection

All Implemented Interfaces:

LocalisedString

public class LocalisedStringCollection
extends java.lang.Object
implements LocalisedString

Implementation to provide a collection of LocalisedStrings. These are localised one by one but the localisation are used as one resulting localised string, similar to an array of strings.

Field Summary

Fields

Modifier and Type	Field and Description
protected LocalisedString[]	ls The strings needing localisation.

Constructor Summary

Constructors

Constructor and Description
LocalisedStringCollection(LocalisedString[] ls) Creates a new collection of LocalisedString.

Method Summary

Modifier and Type	Method and Description
static LocalisedString	loc(java.util.Collection<? extends LocalisedString> ls) Creates a new collection of LocalisedString.
static LocalisedString	loc(LocalisedString[] ls) Creates a new collection of LocalisedString.
java.lang.String	toLocalisedString(LocalisationFactory locFac, java.util.Locale loc) Gets the localised representation of the implementing object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ls

protected final LocalisedString[] ls

The strings needing localisation.

Constructor Detail

LocalisedStringCollection

public LocalisedStringCollection(LocalisedString[] ls)

Creates a new collection of LocalisedString.

Parameters:

ls - The strings needing localisation.

Method Detail

loc

public static LocalisedString loc(LocalisedString[] ls)

Creates a new collection of LocalisedString.

Parameters:

ls - The strings needing localisation.

Returns:

A LocalisedString representing a collection of LocalisedStrings.

loc

public static LocalisedString loc(java.util.Collection<? extends LocalisedString> ls)

Creates a new collection of LocalisedString.

Parameters:

ls - The strings needing localisation.

Returns:

A LocalisedString representing a collection of LocalisedStrings.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toLocalisedString

public java.lang.String toLocalisedString(LocalisationFactory locFac,
                                          java.util.Locale loc)

Description copied from interface: LocalisedString

Gets the localised representation of the implementing object. The localisation should be for the designated locale, model objects being Localised should use the designated localisation factory for automatic localisation.

Specified by:

toLocalisedString in interface LocalisedString

Parameters:

locFac - The localisation factory to be used by Localised model objects. If this is null, do not localise the used Localised attributes.

loc - The locale for which to get the localised string. If this is null, treat it like Locale.ROOT has been requested.

Returns:

The localised (string) representation of the implementing object for the designated locale using the designated localisation factory if appropriate.