js.util

Class I18nFile

java.lang.Object

js.util.I18nFile

public class I18nFile
extends Object

An immutable file on a I18nRepository, bound to a specific locale settings. If parent repository has no multiple locale support this class locale field is always null.

If locale argument is provided to constructor, it should be based only on language and optional country, encoded with ISO 639 alpha-2, respective ISO 3166 alpha-2; script, variant and extension are empty. Constructor throws illegal argument exception if locale argument has variant, script or extension.

Version:

final

Author:

Iulian Rotaru

Field Summary

Fields

Modifier and Type	Field and Description
private File	file The file path.
private Locale	locale Locale settings this file belongs to, always null if parent repository has no support for multiple locale.

Constructor Summary

Constructors

Constructor and Description
I18nFile(File file) Construct not locale sensitive I18N file instance.
I18nFile(File file, Locale locale) Construct I18N file instance bound to specified locale settings.

Method Summary

Modifier and Type	Method and Description
File	getFile() Get path of the underlying filesystem file.
String	getLanguageTag() Convenient method to retrieve locale language tag, possible null.
Locale	getLocale() Get bound locale settings or null, if parent repository has no multiple locale support.
String	getName() Convenient method to retrieve file name.

Methods inherited from class java.lang.Object

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

Field Detail

file

private final File file

The file path.

locale

private final Locale locale

Locale settings this file belongs to, always null if parent repository has no support for multiple locale. Locale settings is based only on language and optional country, encoded with ISO 639 alpha-2, respective ISO 3166 alpha-2; script, variant and extension are empty.

Constructor Detail

I18nFile

I18nFile(File file)
  throws IllegalArgumentException

Construct not locale sensitive I18N file instance. Locale settings field is initialized to null.

Parameters:

file - underlying filesystem file path.

Throws:

IllegalArgumentException

I18nFile

I18nFile(File file,
         Locale locale)
  throws IllegalArgumentException

Construct I18N file instance bound to specified locale settings. Given locale should be based only on language and optional country, encoded with ISO 639 alpha-2, respective ISO 3166 alpha-2; script, variant and extension should be empty.

Parameters:

file - underlying filesystem file path,

locale - locale settings.

Throws:

IllegalArgumentException - if locale argument is null or has variant, script or extension.

Method Detail

getFile

public File getFile()

Get path of the underlying filesystem file.

Returns:

underlying filesystem file path.

See Also:

file

getName

public String getName()

Convenient method to retrieve file name.

Returns:

file name, never null.

See Also:

file

getLocale

public Locale getLocale()

Get bound locale settings or null, if parent repository has no multiple locale support. If not null, locale settings is based only on language and optional country, encoded with ISO 639 alpha-2, respective ISO 3166 alpha-2; script, variant and extension are empty.

Returns:

bound locale settings, possible null.

See Also:

locale

getLanguageTag

public String getLanguageTag()

Convenient method to retrieve locale language tag, possible null.

Returns:

locale language tag or null if locale is missing.

See Also:

locale