Package com.iizix.prop

Class References.Result

java.lang.Object
com.iizix.prop.References.Result
All Implemented Interfaces:
ILocaleKStringFormatter, ILocaleStringFormatter
Enclosing class:
References
public static class References.Result extends Object implements ILocaleKStringFormatter
Class containing result found during reference collection.
Author:
Christopher Mindus

  • Method Details

    • isSuccess

      public boolean isSuccess()
      Checks if the result of the operation was a success.
      Returns:
      true if the returnCode is References.ReturnCode.SUCCESS.

    • getReturnCode

      public References.ReturnCode getReturnCode()
      Gets the return code.
      Returns:
      The return code.

    • getReferenceSource

      public IGProp<?> getReferenceSource()
      Gets the reference source property.
      Returns:
      The source of the reference.

    • getReferenceTarget

      public IGProp<?> getReferenceTarget()
      Gets the reference target property.
      Returns:
      The target reference.

    • getFormatterString

      public String getFormatterString(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
      Gets the String used to format the locale string.
      Specified by:
      getFormatterString in interface ILocaleStringFormatter
      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.

    • getFormatterParams

      public Object[] getFormatterParams(ILocaleString localeString, IKStringInfoProvider provider, LocaleInfo localeInfo)
      Gets the parameters used to format the String.
      Specified by:
      getFormatterParams in interface ILocaleStringFormatter
      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:
      An array of parameters used to format the String. The return value can be set to null in which case an empty array is used for the formatter.

    • getEnglishMessage

      public String getEnglishMessage()
      Fast English string with parameters.
      Returns:
      The formatted string with its parameters.