Interface LocalizedProperties

All Known Implementing Classes:
ExtensionLocalizationProperties

public interface LocalizedProperties
The localization interface to access and parse a locale file
  • Method Details

    • getItemProperties

      Collection<PropertyKey> getItemProperties()
      Retrieves all properties in this file localizing item types.
      Returns:
      item type properties in this file or an empty collection, if this file does not contain item type properties.
    • getAttributeProperties

      Collection<PropertyKey> getAttributeProperties()
      Retrieves all property keys for an item attribute localization in this file.
      Returns:
      a collection of all attribute properties in this file or an empty collection, if this file does not contain attribute properties.
    • getPropertiesNotMatchingNamingConventions

      Collection<String> getPropertiesNotMatchingNamingConventions()
      Retrieves all properties that do not match naming conventions accepted for this localization properties file.
      Returns:
      localization property keys that do not match the naming convention or an empty collection, if all properties match the naming conventions for this localization properties file or, if this file is empty and does not contain any localization properties.
    • keyExistsForItem

      boolean keyExistsForItem(String itemType)
      Verifies if there is a key in the relevant property file for the specified item type.
      Parameters:
      itemType - the item type which we are verifying that exists in the properties file
      Returns:
      whether the key is present or not in the file
    • keyExistsForAttribute

      boolean keyExistsForAttribute(String itemType, String attribute)
      Verifies if there is a key in the relevant property file for the specified item type attribute.
      Parameters:
      itemType - the item type of the attribute which we are looking for
      attribute - the attribute which we are verifying that exists in the properties file
      Returns:
      whether the attribute is present or not in the file
    • getValidPropertiesWithoutValues

      Collection<String> getValidPropertiesWithoutValues()
      Retrieves all properties with names following the naming conventions for this localization file but not having values.
      Returns:
      a collection of properties without localized values or an empty collection, if all properties are localized or this file is empty.