org.apache.pluto.om.common
Interface LanguageSet

All Superinterfaces:

Model

public interface LanguageSet
extends Model

This interface provides access to a set of Language objects.

This interface defines the model as known from the MVC pattern. Its purpose is to provide read access to the data stored in the model.

Method Summary

Language	get(java.util.Locale locale) Returns the language object of the given locale.
java.util.Locale	getDefaultLocale() Returns the default locale object or NULL if there is no default locale
java.util.Iterator	getLocales() Returns a iterator of all supported locales by this portlet The return value cannot be NULL.
java.util.Iterator	iterator() Returns all elements of this set as iterator The return value cannot be NULL.

Method Detail

iterator

java.util.Iterator iterator()

Returns all elements of this set as iterator The return value cannot be NULL.

Returns:

An iterator containing all language objects

getLocales

java.util.Iterator getLocales()

Returns a iterator of all supported locales by this portlet The return value cannot be NULL.

Returns:

an iterator containing all supported locales as java.util.Locale objects

get

Language get(java.util.Locale locale)

Returns the language object of the given locale. If the given locale is not supported the Language of the preferred locale will be returned. The return value may be NULL if there is no preferred locale as well.

Returns:

the language object of the given locale

getDefaultLocale

java.util.Locale getDefaultLocale()

Returns the default locale object or NULL if there is no default locale

Returns:

the default locale object or NULL if there is no default locale