Package io.quarkus.registry.catalog

Interface ExtensionCatalog

All Superinterfaces:
ExtensionOrigin
All Known Subinterfaces:
ExtensionCatalog.Mutable
All Known Implementing Classes:
ExtensionCatalogImpl, ExtensionCatalogImpl.Builder
public interface ExtensionCatalog extends ExtensionOrigin

  • Field Details

  • Method Details

    • getDerivedFrom

      List<ExtensionOrigin> getDerivedFrom()
      All the origins this catalog is derived from.
      Returns:
      all the origins this catalog derives from.

    • getQuarkusCoreVersion

      String getQuarkusCoreVersion()
      Quarkus core version used by the extensions in this catalog.
      Returns:
      Quarkus core version used by the extensions in this catalog

    • getUpstreamQuarkusCoreVersion

      String getUpstreamQuarkusCoreVersion()
      In case the catalog was built for a custom version of the Quarkus core, this version represents the corresponding upstream community Quarkus core version. This is done to be able to link the custom builds of Quarkus back to the upstream community extensions ecosystem. This method may return null in case the corresponding version does not exist in the upstream community or simply to link back to it.
      Returns:
      the upstream community Quarkus core version corresponding to the Quarkus core version used in this catalog

    • getExtensions

      Collection<Extension> getExtensions()
      Quarkus extensions that constitute the catalog.
      Returns:
      Quarkus extensions that constitute the catalog.

    • getCategories

      List<Category> getCategories()
      Extension categories
      Returns:
      extension categories

    • mutable

      default ExtensionCatalog.Mutable mutable()
      Specified by:
      mutable in interface ExtensionOrigin
      Returns:
      a mutable copy of this configuration

    • persist

      default void persist(Path p) throws IOException
      Persist this configuration to the specified file.
      Parameters:
      p - Target path
      Throws:
      IOException - if the specified file can not be written to.

    • builder

      static ExtensionCatalog.Mutable builder()
      Returns:
      a new mutable instance

    • fromFile

      static ExtensionCatalog fromFile(Path path) throws IOException
      Read config from the specified file
      Parameters:
      path - File to read from (yaml or json)
      Returns:
      read-only ExtensionCatalog object
      Throws:
      IOException

    • mutableFromFile

      static ExtensionCatalog.Mutable mutableFromFile(Path path) throws IOException
      Read config from the specified file
      Parameters:
      path - File to read from (yaml or json)
      Returns:
      read-only ExtensionCatalog object (empty/default for an empty file)
      Throws:
      IOException

    • fromStream

      static ExtensionCatalog fromStream(InputStream inputStream) throws IOException
      Read config from an input stream
      Parameters:
      inputStream - input stream to read from
      Returns:
      read-only ExtensionCatalog object (empty/default for an empty file)
      Throws:
      IOException