Interface IMessageKeyVerifier

  • All Known Implementing Classes:
    MessageKeyVerifier

    public interface IMessageKeyVerifier
    An interface for verifying that given an enum type, the keys match those found in the corresponding resource bundles.

    See also MessageKeyVerifier for a concrete implementation.

    Author:
    Ceki Gülcü
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getBaseName()
      Get the base name for the resource bundle family as specified in the enumType (via annotations)
      java.lang.Class<? extends java.lang.Enum<?>> getEnumType()
      Get the of enum type that this verifier is related to to.
      java.lang.String getEnumTypeAsStr()
      Get the name of enum type to this verifier is related to to.
      java.lang.String[] getLocaleNames()
      Get the locales specified in the enumType (via annotations)
      java.util.List<java.lang.String> typeIsolatedVerify​(java.util.Locale locale)
      Same as verify(Locale) except that the return type is List.
      java.util.List<Cal10nError> verify​(java.util.Locale locale)
      Verify that the keys defined in the enumClass match those found in the resource bundle corresponding to a certain locale
      java.util.List<Cal10nError> verifyAllLocales()
      Verify that the keys defined in the enumClass match those found in the corresponding resource bundle for all locales declared in the enum type via the @LocaleData annotation.
    • Method Detail

      • getEnumType

        java.lang.Class<? extends java.lang.Enum<?>> getEnumType()
        Get the of enum type that this verifier is related to to.
        Returns:
      • getEnumTypeAsStr

        java.lang.String getEnumTypeAsStr()
        Get the name of enum type to this verifier is related to to.
        Returns:
      • verify

        java.util.List<Cal10nError> verify​(java.util.Locale locale)
        Verify that the keys defined in the enumClass match those found in the resource bundle corresponding to a certain locale
        Parameters:
        locale -
        Returns:
      • verifyAllLocales

        java.util.List<Cal10nError> verifyAllLocales()
        Verify that the keys defined in the enumClass match those found in the corresponding resource bundle for all locales declared in the enum type via the @LocaleData annotation.
        Parameters:
        locale -
        Returns:
      • typeIsolatedVerify

        java.util.List<java.lang.String> typeIsolatedVerify​(java.util.Locale locale)
        Same as verify(Locale) except that the return type is List.
        Parameters:
        locale -
        Returns:
      • getLocaleNames

        java.lang.String[] getLocaleNames()
        Get the locales specified in the enumType (via annotations)
        Returns:
      • getBaseName

        java.lang.String getBaseName()
        Get the base name for the resource bundle family as specified in the enumType (via annotations)
        Returns: