Package ca.corbett.extensions

Class AppExtensionInfo

java.lang.Object
ca.corbett.extensions.AppExtensionInfo
public class AppExtensionInfo extends Object
Allows an extension to provide some basic metadata about itself. Name, version, targetAppName, and targetAppVersion should be considered mandatory, with the remaining fields being optional. Extra application-specific fields can be thrown into the custom field map, but you are restricted to simple single-line string values. Every extension should package an extInfo.json file as a resource into its jar file so that it can be discovered and interrogated by ExtensionManager.

See ExtensionManager.extractExtInfo() for more details.

Refer to the swing-extras documentation for full documentation.

Since:
2023-11-11
Author:
scorbo2

  • Field Details

    • INVALID

      public static final int INVALID
      See Also:

    • EXT_TYPE_BUILTIN

      public static final String EXT_TYPE_BUILTIN
      See Also:

    • EXT_TYPE_SYSTEM

      public static final String EXT_TYPE_SYSTEM
      See Also:

    • EXT_TYPE_USER

      public static final String EXT_TYPE_USER
      See Also:

    • gson

      protected static com.google.gson.Gson gson

    • name

      protected final String name

    • version

      protected final String version

    • projectUrl

      protected final String projectUrl

    • targetAppName

      protected final String targetAppName

    • targetAppVersion

      protected final String targetAppVersion

    • author

      protected final String author

    • authorUrl

      protected final String authorUrl

    • releaseNotes

      protected final String releaseNotes

    • shortDescription

      protected final String shortDescription

    • longDescription

      protected final String longDescription

    • customFields

      protected final Map<String,String> customFields

  • Constructor Details

  • Method Details

    • toJson

      public String toJson()

    • fromJson

      public static AppExtensionInfo fromJson(String json)
      Attempts to parse an AppExtensionInfo out of the given json. Any field not mentioned in the json will be returned as null.
      Parameters:
      json - A json representation of an AppExtensionInfo object.
      Returns:
      An AppExtensionInfo object, or null if parsing was not possible.

    • fromStream

      public static AppExtensionInfo fromStream(InputStream stream)
      Attempts to parse an AppExtensionInfo instance out of json read from the given InputStream. Example usage in an extension: 
       AppExtensionInfo.fromStream(this.getClass().getClassLoader().getResourceAsStream("/path/extInfo.json"));
      Parameters:
      stream - An InputStream containing json.
      Returns:
      An AppExtensionInfo object, or null if parsing was not possible.

    • fromExtensionJar

      public static AppExtensionInfo fromExtensionJar(Class<? extends AppExtension> extensionClass, String resource)
      Attempts to use the given Class to read extInfo from the given jar resource. This is intended to be invoked by extension jars, where resources have to be loaded from the class that is present in the jar that contains them.
      Parameters:
      extensionClass - the extension class responsible for loading the resource.
      resource - the jar resource to be loaded (full resource path and name of extInfo.json)
      Returns:
      A parsed AppExtensionInfo object, or null if the resource could not be read.

    • extractMajorVersion

      public static int extractMajorVersion(String version)
      Extracts and returns the major version number from the given version string. Ignores any non-numeric characters. If no major version can be determined, returns INVALID.

    • getName

      public String getName()

    • getAuthor

      public String getAuthor()

    • getAuthorUrl

      public String getAuthorUrl()

    • getProjectUrl

      public String getProjectUrl()

    • getVersion

      public String getVersion()

    • getMajorVersion

      public int getMajorVersion()

    • getTargetAppName

      public String getTargetAppName()

    • getTargetAppVersion

      public String getTargetAppVersion()

    • getTargetAppMajorVersion

      public int getTargetAppMajorVersion()

    • getShortDescription

      public String getShortDescription()

    • getLongDescription

      public String getLongDescription()

    • getReleaseNotes

      public String getReleaseNotes()

    • getCustomFieldNames

      public List<String> getCustomFieldNames()

    • getCustomFieldValue

      public String getCustomFieldValue(String fieldName)

    • equals

      public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isValid

      public final boolean isValid()
      Validates this AppExtensionInfo to ensure that all required fields are present and well-formed. ExtensionManager will check this during extension load to ensure that the candidate extension has packaged a well-formed extInfo.json file. This method is final to prevent these checks from being relaxed or skipped.

    • getGson

      protected static com.google.gson.Gson getGson()