pro.fessional.mirana.i18n

Interface I18nAware

All Superinterfaces:

Serializable

All Known Subinterfaces:

CodeEnum, I18nEnum

All Known Implementing Classes:

AssertErrorEnum, BadArgsException, BadStateException, CodeException, CrudErrorEnum, CrudException, HttpStatusException, I18nMessage, I18nName, I18nNotice, I18nString, MessageException, PageResult, R, R.Immutable

public interface I18nAware
extends Serializable

code should be fixed. hint and args can be changed.

Since:

2019-09-09

Author:

trydofor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	I18nAware.I18nSource

Method Summary

Modifier and Type	Method and Description
default void	applyLocale(Locale locale, @NotNull I18nAware.I18nSource source) apply the internal locale and updates the i18n state based on the provided source.
@Nullable Object[]	getI18nArgs() the args of template
default Object[]	getI18nArgsIf(boolean nonnull)
default Object[]	getI18nArgsOr(Object... elze)
@Nullable String	getI18nCode() the i18n code, also template id
default String	getI18nCodeIf(boolean nonnull)
default String	getI18nCodeOr(String elze)
@Nullable String	getI18nHint() the default message or template (if no template by code)
default String	getI18nHintIf(boolean nonnull)
default String	getI18nHintOr(String elze)
default @NotNull I18nString	toI18nString()
default @NotNull I18nString	toI18nString(String hint) use getI18nHint() if hint is null
default @NotNull I18nString	toI18nString(String hint, Object... args) use getI18nHint() if hint is null, getI18nArgs() if args is null
default String	toString(Locale locale)
default String	toString(Locale locale, @NotNull I18nAware.I18nSource source)
static String	toString(Locale locale, @NotNull I18nAware.I18nSource source, String code, String hint, Object... args) should use Locale.getDefault() if locale is null.

Method Detail

getI18nCode

@Nullable
@Nullable String getI18nCode()

the i18n code, also template id

getI18nCodeIf

@Contract(value="true->!null")
default String getI18nCodeIf(boolean nonnull)

getI18nCodeOr

@Contract(value="!null->!null")
default String getI18nCodeOr(String elze)

getI18nHint

@Nullable
@Nullable String getI18nHint()

the default message or template (if no template by code)

getI18nHintIf

@Contract(value="true->!null")
default String getI18nHintIf(boolean nonnull)

getI18nHintOr

@Contract(value="!null->!null")
default String getI18nHintOr(String elze)

getI18nArgs

@Nullable
@Nullable Object[] getI18nArgs()

the args of template

getI18nArgsIf

@Contract(value="true->!null")
default Object[] getI18nArgsIf(boolean nonnull)

getI18nArgsOr

@Contract(value="!null->!null")
default Object[] getI18nArgsOr(Object... elze)

toI18nString

@NotNull
default @NotNull I18nString toI18nString()

toI18nString

@NotNull
default @NotNull I18nString toI18nString(String hint)

use getI18nHint() if hint is null

toI18nString

@NotNull
default @NotNull I18nString toI18nString(String hint,
                                                  Object... args)

use getI18nHint() if hint is null, getI18nArgs() if args is null

toString

default String toString(Locale locale)

See Also:

toString(Locale, I18nSource, String, String, Object...)

toString

default String toString(Locale locale,
                        @NotNull
                        @NotNull I18nAware.I18nSource source)

See Also:

toString(Locale, I18nSource, String, String, Object...)

applyLocale

default void applyLocale(Locale locale,
                         @NotNull
                         @NotNull I18nAware.I18nSource source)

apply the internal locale and updates the i18n state based on the provided source.

Parameters:

locale - the locale to be applied

source - the i18n source providing the translations

toString

@Contract(value="_,_,!null,_,_->!null")
static String toString(Locale locale,
                                                               @NotNull
                                                               @NotNull I18nAware.I18nSource source,
                                                               String code,
                                                               String hint,
                                                               Object... args)

 should use Locale.getDefault() if locale is null.
 return the hint if code is empty.
 return the code if format message get empty.
 recursively evaluate the args if its item is I18nAware