Package io.quarkus.cli.plugin

Class PluginCatalogService

java.lang.Object

io.quarkus.cli.plugin.CatalogService<PluginCatalog>

io.quarkus.cli.plugin.PluginCatalogService

public class PluginCatalogService
extends CatalogService<PluginCatalog>

Field Summary

Fields inherited from class io.quarkus.cli.plugin.CatalogService

catalogType, EXISTS_AND_WRITABLE, GIT_ROOT, HAS_BUILD_GRADLE, HAS_POM_XML, IS_ELIGIBLE_PROJECT_ROOT, IS_USER_HOME, objectMapper, projectRoot, relativePath, USER_HOME

Constructor Summary

Constructors

Constructor	Description
PluginCatalogService()
PluginCatalogService(Function<Path,Path> relativePath)
PluginCatalogService(Predicate<Path> projectRoot, Function<Path,Path> relativePath)

Method Summary

Modifier and Type	Method	Description
PluginCatalog	readCombinedCatalog(Optional<Path> proejctDir, Optional<Path> userDir)	Read the PluginCatalog from project or fallback to global catalog.
Optional<PluginCatalog>	readProjectCatalog(Optional<Path> dir)
Optional<PluginCatalog>	readUserCatalog(Optional<Path> userDir)	Reads the plguin catalog from the user home.

Methods inherited from class io.quarkus.cli.plugin.CatalogService

findProjectCatalogPath, findProjectCatalogPath, findProjectRoot, getCatalogPath, getRelativeCatalogPath, getRelativeCatalogPath, getUserCatalogPath, getUserCatalogPath, readCatalog, readCatalog, writeCatalog

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginCatalogService

public PluginCatalogService()

PluginCatalogService

public PluginCatalogService(Function<Path,Path> relativePath)

PluginCatalogService

public PluginCatalogService(Predicate<Path> projectRoot,
                            Function<Path,Path> relativePath)

Method Detail

readUserCatalog

public Optional<PluginCatalog> readUserCatalog(Optional<Path> userDir)

Description copied from class: CatalogService

Reads the plguin catalog from the user home.

Overrides:

readUserCatalog in class CatalogService<PluginCatalog>

Returns:

a catalog wrapped in optional or empty if the catalog is not present.

readProjectCatalog

public Optional<PluginCatalog> readProjectCatalog(Optional<Path> dir)

Overrides:

readProjectCatalog in class CatalogService<PluginCatalog>

readCombinedCatalog

public PluginCatalog readCombinedCatalog(Optional<Path> proejctDir,
                                         Optional<Path> userDir)

Read the PluginCatalog from project or fallback to global catalog.

Parameters:

ouput - an OutputOptionMixin that can be used for tests to substitute current dir with a test directory.

projectDir - An optional path pointing to the project directory.

userdir - An optional path pointing to the user directory

Returns:

the catalog