Package io.quarkus.cli.plugin

Class PluginManagerSettings

java.lang.Object

io.quarkus.cli.plugin.PluginManagerSettings

public class PluginManagerSettings
extends Object

Settings class for the PluginManager. The PluginManager can be used beyond the Quarkus CLI. Users are able to build extensible CLI apps using the PluginManager with customized settings.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_PLUGIN_PREFIX
static Function<Path,Path>	DEFAULT_RELATIVE_PATH_FUNC
static String[]	DEFAULT_REMOTE_JBANG_CATALOGS
static String	FALLBACK_REMOTE_JBANG_CATALOG

Constructor Summary

Constructors

Constructor	Description
PluginManagerSettings(boolean interactiveMode, String pluginPrefix, String fallbackJBangCatalog, String[] remoteJBangCatalogs, Function<Path,Path> toRelativePath)

Method Summary

Modifier and Type	Method	Description
static PluginManagerSettings	defaultSettings()
String	getFallbackJBangCatalog()	The name of the fallback JBang catalogs to get plugins from.
String	getPluginPrefix()	The prefix of the Plugin.
String[]	getRemoteJBangCatalogs()	The names of the JBang catalogs to get plugins from.
Function<Path,Path>	getToRelativePath()	A Function from getting the relative path to the catalog.
boolean	isInteractiveMode()
PluginManagerSettings	withCatalogs(String... remoteJBangCatalogs)
PluginManagerSettings	withCatalogs(Set<String> remoteJBangCatalogs)
PluginManagerSettings	withInteractivetMode(boolean interactiveMode)
PluginManagerSettings	withPluignPrefix(String pluginPrefix)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PLUGIN_PREFIX

public static String DEFAULT_PLUGIN_PREFIX

FALLBACK_REMOTE_JBANG_CATALOG

public static String FALLBACK_REMOTE_JBANG_CATALOG

DEFAULT_REMOTE_JBANG_CATALOGS

public static String[] DEFAULT_REMOTE_JBANG_CATALOGS

DEFAULT_RELATIVE_PATH_FUNC

public static Function<Path,Path> DEFAULT_RELATIVE_PATH_FUNC

Constructor Details

PluginManagerSettings

public PluginManagerSettings(boolean interactiveMode,
 String pluginPrefix,
 String fallbackJBangCatalog,
 String[] remoteJBangCatalogs,
 Function<Path,Path> toRelativePath)

Method Details

defaultSettings

public static PluginManagerSettings defaultSettings()

withPluignPrefix

public PluginManagerSettings withPluignPrefix(String pluginPrefix)

withCatalogs

public PluginManagerSettings withCatalogs(Set<String> remoteJBangCatalogs)

withCatalogs

public PluginManagerSettings withCatalogs(String... remoteJBangCatalogs)

withInteractivetMode

public PluginManagerSettings withInteractivetMode(boolean interactiveMode)

getPluginPrefix

public String getPluginPrefix()

The prefix of the Plugin. This value is used to strip the prefix for the location when creating the name.

Returns:

the prefix.

getFallbackJBangCatalog

public String getFallbackJBangCatalog()

The name of the fallback JBang catalogs to get plugins from.

Returns:

the name of the catalog.

getRemoteJBangCatalogs

public String[] getRemoteJBangCatalogs()

The names of the JBang catalogs to get plugins from.

Returns:

the name of the catalog.

isInteractiveMode

public boolean isInteractiveMode()

getToRelativePath

public Function<Path,Path> getToRelativePath()

A Function from getting the relative path to the catalog. For example: `~ -> ~/.quarkus/cli/plugins/quarkus-cli-catalog.json`.

Returns:

the path.