Package de.espirit.firstspirit.module.descriptor

Class ModuleDescriptor

java.lang.Object
de.espirit.firstspirit.module.descriptor.AbstractDescriptor
de.espirit.firstspirit.module.descriptor.ModuleDescriptor
All Implemented Interfaces:
Descriptor, Serializable
public class ModuleDescriptor extends de.espirit.firstspirit.module.descriptor.AbstractDescriptor implements Descriptor
FirstSpirit Module (FSM) descriptor, containing all information of a specific module and its components.
Since:
5.1.103
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class de.espirit.firstspirit.module.descriptor.AbstractDescriptor

    de.espirit.firstspirit.module.descriptor.AbstractDescriptor.ResourceDescriptor

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModuleDescriptor()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable ComponentDescriptor
    getComponentByName(@Nullable String name)
    Returns a component by its name or null if it couldn't be found.
    @NotNull ComponentDescriptor[]
    getComponents()
    Returns all components of this module.
    @Nullable String
    getMinFsVersion()
    Returns the minimal version of FirstSpirit required to install this module.
    String
    getVendor()
    Returns the vendor information of this module.

    Methods inherited from class de.espirit.firstspirit.module.descriptor.AbstractDescriptor

    compareVersion, getAttribute, getComponentClass, getConfiguration, getConfigurationClass, getDependencies, getDescription, getDisplayName, getModuleName, getName, getNodeValue, getNodeValue, getResources, getScope, getScope, getVersion, getVersion, isHidden, isSystem, isUnknown, toString, validate

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface de.espirit.firstspirit.module.descriptor.Descriptor

    getConfiguration, getDescription, getDisplayName, getName, getVersion

  • Constructor Details

    • ModuleDescriptor

      public ModuleDescriptor()

  • Method Details

    • getComponentByName

      @Nullable public @Nullable ComponentDescriptor getComponentByName(@Nullable @Nullable String name)
      Returns a component by its name or null if it couldn't be found.
      Parameters:
      name - component name.
      Returns:
      component by name.
      Since:
      5.1.103

    • getComponents

      @NotNull public @NotNull ComponentDescriptor[] getComponents()
      Returns all components of this module.
      Returns:
      all component descriptors.
      Since:
      5.1.103

    • getVendor

      public String getVendor()
      Returns the vendor information of this module.
      Returns:
      vendor of this module.
      Since:
      5.1.103

    • getMinFsVersion

      @Nullable public @Nullable String getMinFsVersion()
      Returns the minimal version of FirstSpirit required to install this module. The version will always be specified in a format like "5.2.230707".
      Returns:
      the minimal FirstSpirit version or null if any version is sufficient.
      Since:
      5.2.231002