All Superinterfaces:: ILocaleStringFormatter

All Known Implementing Classes:: References.Result

public interface ILocaleKStringFormatter extends ILocaleStringFormatter

Helper to format a message with parameters for a class in the appropriate String form.

Author:: Christopher Mindus

Field Summary
Fields inherited from interface com.iizix.text.ILocaleStringFormatter
EMPTY
Method Summary
Modifier and Type
Method
Description
default KString
getFormatterKString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
Gets the KString used to format the locale string.
default KString
getMessageLocaleKString()
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(LocaleInfo localeInfo)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(IKStringInfoProvider provider)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(IKStringInfoProvider provider, LocaleInfo localeInfo)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(IKStringInfoProvider provider, ILocaleString localeString)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(IKStringInfoProvider provider, Locale locale)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(ILocaleString localeString)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocaleKString(Locale locale)
Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString()
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(LocaleInfo localeInfo)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(IKStringInfoProvider provider)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(IKStringInfoProvider provider, LocaleInfo localeInfo)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(IKStringInfoProvider provider, ILocaleString localeString)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(IKStringInfoProvider provider, Locale locale)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(ILocaleString localeString)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
default KString
getMessageLocalePlainKString(Locale locale)
Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
Methods inherited from interface com.iizix.text.ILocaleStringFormatter
getFormatterParams, getFormatterString, getMessageLocaleString, getMessageLocaleString, getMessageLocaleString, getMessageLocaleString, getMessageLocaleString, getMessageLocaleString

Method Details
- getFormatterKString
  default KString getFormatterKString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
  Gets the KString used to format the locale string.
  Parameters:
  localeString - The locale string instance, or null to look it up from current thread or system.
  provider - The information provider or null for none.
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The locale string to format with potential parameters.
- getMessageLocaleKString
  default KString getMessageLocaleKString()
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats the HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The locale and potential IKStringInfoProvider provider is looked up from the current thread if required.
  Returns:
  The formatted KString.
  See Also:
  KString.format(Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(IKStringInfoProvider provider)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats the HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The locale is looked up from the current thread if required.
  Parameters:
  provider - The information provider or null to look it up for the current session.
  Returns:
  The formatted KString.
  See Also:
  KString.format(IKStringInfoProvider, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(Locale locale)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  Parameters:
  locale - The Locale, or null to look it up for the current thread if needed.
  Returns:
  The formatted KString.
  See Also:
  KString.format(Locale, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(IKStringInfoProvider provider, Locale locale)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  Parameters:
  provider - The information provider or null to look it up for the current session.
  locale - The Locale, or null to look it up for the current thread if needed.
  Returns:
  The formatted KString.
  See Also:
  KString.format(IKStringInfoProvider, Locale, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(ILocaleString localeString)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The IKStringInfoProvider is looked up from the current session.
  Parameters:
  localeString - The locale string instance, or null for current session.
  Returns:
  The formatted KString.
  See Also:
  KString.format(ILocaleString, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(IKStringInfoProvider provider, ILocaleString localeString)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  Parameters:
  provider - The information provider or null to look it up for the current session.
  localeString - The locale string instance, or null for current session.
  Returns:
  The formatted KString.
  See Also:
  KString.format(IKStringInfoProvider, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(LocaleInfo localeInfo)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a String using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The IKStringInfoProvider is looked up from the current session.
  Parameters:
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The formatted KString.
  See Also:
  KString.format(LocaleInfo, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(IKStringInfoProvider provider, LocaleInfo localeInfo)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a String using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The IKStringInfoProvider is looked up from the current session.
  Parameters:
  provider - The information provider or null for none.
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The formatted KString.
  See Also:
  KString.format(IKStringInfoProvider, LocaleInfo, Object...)
- getMessageLocaleKString
  default KString getMessageLocaleKString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
  Gets a formatted HTML or PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a String using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to HTML or PLAIN KString's, depending on this KString instance type.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The IKStringInfoProvider is looked up from the current session.
  Parameters:
  localeString - The locale string instance, or null to look it up from current thread or system.
  provider - The information provider or null for none.
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The formatted KString.
  See Also:
  KString.format(IKStringInfoProvider, LocaleInfo, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString()
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats the HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The locale and potential IKStringInfoProvider provider is looked up from the current thread if required.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(IKStringInfoProvider provider)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats the HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link Utilities#toString()} enable e.g. deep-to-String of e.g. Exceptions, Arrays, etc. Parameters references e.g. using %s will not receive this "toString" conversion (unless they target the same param_index.
  Parameters referenced by {[param_index]} that are KString types are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The locale is looked up from the current thread if required.
  Parameters:
  provider - The information provider or null to look it up for the current session.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(IKStringInfoProvider, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(Locale locale)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  Parameters:
  locale - The Locale, or null to look it up for the current thread if needed.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(Locale, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(IKStringInfoProvider provider, Locale locale)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  Parameters:
  provider - The information provider or null to look it up for the current session.
  locale - The Locale, or null to look it up for the current thread if needed.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(IKStringInfoProvider, Locale, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(ILocaleString localeString)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The IKStringInfoProvider provider parameter is looked up from the current session.
  Parameters:
  localeString - The locale string instance, or null for current session.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(ILocaleString, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(IKStringInfoProvider provider, ILocaleString localeString)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a HTML or PLAIN KString using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  Parameters:
  provider - The information provider or null to look it up for the current session.
  localeString - The locale string instance, or null for current session.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(IKStringInfoProvider, ILocaleString, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(LocaleInfo localeInfo)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a String using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The formatting string replaces {} with %s and {param_index} with %param_index$s.
  The IKStringInfoProvider is looked up from the current session.
  Parameters:
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(LocaleInfo, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(IKStringInfoProvider provider, LocaleInfo localeInfo)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a String using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The IKStringInfoProvider provider parameter is looked up from the current session.
  Parameters:
  provider - The information provider or null for none.
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(IKStringInfoProvider, LocaleInfo, Object...)
- getMessageLocalePlainKString
  default KString getMessageLocalePlainKString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
  Gets a formatted PLAIN KString with the appropriate parameters using the formatting described below.
  Formats a String using curly brackets {} as parameter or {param_index} parameter where param_index is an optional one-based index value, AND/OR the Java String.format(Locale, String, Object...) method using parameters in the form of %[flags][width]conversion or %[argument_index$][flags][width]conversion.
  Parameters referenced by {[param_index]} are converted toString() using {@link toString()}, except when the parameters are KString's in which case they are converted to PLAIN KString's.
  The IKStringInfoProvider provider parameter is looked up from the current session.
  Parameters:
  localeString - The locale string instance, or null to look it up from current thread or system.
  provider - The information provider or null for none.
  localeInfo - The Locale information, or null to look it up from the current thread if needed.
  Returns:
  The formatted PLAIN KString.
  See Also:
  KString.formatPLAIN(IKStringInfoProvider, LocaleInfo, Object...)

Interface ILocaleKStringFormatter

Field Summary

Fields inherited from interface com.iizix.text.ILocaleStringFormatter

Method Summary

Methods inherited from interface com.iizix.text.ILocaleStringFormatter

Method Details

getFormatterKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocaleKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString

getMessageLocalePlainKString