Interface DescribePropertiesable

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBaseName()
      Defines the Properties file/class baseName which is used to find descriptions of an entity as per the keys defined in Describeable
      The baseName will be the file without the .properties or the locale codes
      Examples:
      myentity - would match: myentity.properties, myentity_en.properties, myentity_en_GB.properties, etc.
      mydir/myloc/mything - would match: mydir/myloc/mything.properties, etc.
      ClassLoader getResourceClassLoader()
      Defines the ClassLoader which will be used to load the properties bundle file/classes which contain the entity descriptions
    • Method Detail

      • getBaseName

        String getBaseName()
        Defines the Properties file/class baseName which is used to find descriptions of an entity as per the keys defined in Describeable
        The baseName will be the file without the .properties or the locale codes
        Examples:
        myentity - would match: myentity.properties, myentity_en.properties, myentity_en_GB.properties, etc.
        mydir/myloc/mything - would match: mydir/myloc/mything.properties, etc.
        Returns:
        the baseName of the properties file/classes in the getResourceClassLoader()
        See Also:
        for details about the keys to place in the properties file
      • getResourceClassLoader

        ClassLoader getResourceClassLoader()
        Defines the ClassLoader which will be used to load the properties bundle file/classes which contain the entity descriptions
        Returns:
        the ClassLoader which can find the files using getBaseName()