Package com.iizix.prop

Enum Class References.ReturnCode

java.lang.Object
java.lang.Enum<References.ReturnCode>
com.iizix.prop.References.ReturnCode
All Implemented Interfaces:
IEnumLocaleKString, IEnumLocaleString, Serializable, Comparable<References.ReturnCode>, Constable
Enclosing class:
References
public static enum References.ReturnCode extends Enum<References.ReturnCode> implements IEnumLocaleKString
Reference collection return code.

Text IDs used

   references.rc.success   = Success.
   references.rc.not_found = Reference "{1}" not found from "{2}", in "{3}"
   references.rc.circular  = Circular reference "{1}" from "{2}" in "{3}"
   references.rc.crossover = Crossover to circular reference "{1}" from "{2}" in "{3}"
Author:
Christopher Mindus

  • Enum Constant Details

    • SUCCESS

      public static final References.ReturnCode SUCCESS
      Success.

    • NOT_FOUND

      public static final References.ReturnCode NOT_FOUND
      Reference "target" not found from "source", type "reference-type".

    • CIRCULAR

      public static final References.ReturnCode CIRCULAR
      Circular reference in "target" from "source", type "reference-type".

    • CROSSOVER

      public static final References.ReturnCode CROSSOVER
      Crossover to circular reference "target" from "source", type "reference-type".

  • Field Details

    • englishMessage

      public final String englishMessage
      The English text message fallback String.

    • textID

      public final String textID
      The text ID for the message, starts with "references.rc.".

  • Method Details

    • values

      public static References.ReturnCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static References.ReturnCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isSuccess

      public boolean isSuccess()
      Checks if the return code is success.
      Returns:
      True only when it is SUCCESS.

    • getID

      public String getID()
      Gets the text ID.
      Specified by:
      getID in interface IEnumLocaleString
      Returns:
      The text ID string.

    • getFallback

      public String getFallback()
      Gets the fallback String.
      Specified by:
      getFallback in interface IEnumLocaleString
      Returns:
      The fallback string.

    • getKStringFallback

      public KString getKStringFallback()
      Gets the fallback KString.
      Specified by:
      getKStringFallback in interface IEnumLocaleKString
      Returns:
      The fallback KString.