com.sap.localization

Interface LocalizableText

All Superinterfaces:

Localizable, Serializable

All Known Implementing Classes:

LocalizableTextFormatter

public interface LocalizableText

extends Localizable

Interface for general localizable text.

Nested Class Summary

static interface	LocalizableText.Key0 Interface for a message without arguments.
static interface	LocalizableText.Key1 Interface for a message with one argument.
static interface	LocalizableText.Key2 Interface for a message with two arguments.
static interface	LocalizableText.Key3 Interface for a message with three arguments.
static interface	LocalizableText.Key4 Interface for a message with four arguments.
static interface	LocalizableText.Key5 Interface for a message with five arguments.
static interface	LocalizableText.Key6 Interface for a message with six arguments.
static interface	LocalizableText.Msg Helper interface for constructing a LocalizableText class.

Field Summary

Fields inherited from interface com.sap.localization.Localizable

defaultLocale

Method Summary

void	finallyLocalize() Finally localizes the message text.
void	finallyLocalize(Locale loc) Finally localize the message text.
void	finallyLocalize(Locale loc, TimeZone tZone) Finally localize the message text.
void	finallyLocalize(TimeZone tZone) Finally localize the message text.
String	format() Returns the message text.
String	format(Locale loc) Returns the message text.
String	format(Locale loc, TimeZone tZone) Returns the message text.
String	format(TimeZone tZone) Returns the message text.

Methods inherited from interface com.sap.localization.Localizable

getLocale, getTimeZone, setLocale, setTimeZone

Method Detail

format

public String format()
              throws LocalizationException

Returns the message text.

Localization is done with the current locale and time zone. If the finallyLocalize method was called before, the already localized message is returned.

Returns:

localized message text as unicode string

Throws:

LocalizationException - if an error occurred

See Also:

Localizable.setLocale(Locale locale), Localizable.setTimeZone(TimeZone timeZone)

format

public String format(Locale loc)
              throws LocalizationException

Returns the message text.

Localization is done with the specified locale and the current time zone. If the finallyLocalize method was called before, the already localized message is returned.

Parameters:

loc - locale

Returns:

localized message text as unicode string

Throws:

LocalizationException - if an error occurred

format

public String format(TimeZone tZone)
              throws LocalizationException

Returns the message text.

Localization is done with the specified time zone and the current locale. If the finallyLocalize method was called before, the already localized message is returned.

Parameters:

tZone - time zone

Returns:

localized message text as unicode string

Throws:

LocalizationException - if an error occurred

format

public String format(Locale loc,
                     TimeZone tZone)
              throws LocalizationException

Returns the message text.

Localization is done with the specified locale and time zone. If the finallyLocalize method was called before, the already localized message is returned.

Parameters:

loc - locale

tZone - time zone

Returns:

localized message text as unicode string

Throws:

LocalizationException - if an error occurred

finallyLocalize

public void finallyLocalize()
                     throws LocalizationException

Finally localizes the message text.

The ability to do localization on demand gets lost.

Throws:

LocalizationException - if an error occurred

finallyLocalize

public void finallyLocalize(Locale loc)
                     throws LocalizationException

Finally localize the message text. The ability to do localization on demand gets lost.

Parameters:

loc - locale

Throws:

LocalizationException - if an error occurred

See Also:

finallyLocalize()

finallyLocalize

public void finallyLocalize(TimeZone tZone)
                     throws LocalizationException

Finally localize the message text. The ability to do localization on demand gets lost.

Parameters:

tZone - timeZone

Throws:

LocalizationException - if an error occurred

See Also:

finallyLocalize()

finallyLocalize

public void finallyLocalize(Locale loc,
                            TimeZone tZone)
                     throws LocalizationException

Finally localize the message text. The ability to do localization on demand gets lost.

Parameters:

loc - locale

tZone - time zone

Throws:

LocalizationException - if an error occurred

See Also:

finallyLocalize()