A B C D E F G H I J K L M N O P R S T U V W Z
All Classes All Packages

A

AbstractExtensionFinder - Class in org.pf4j

AbstractExtensionFinder(PluginManager) - Constructor for class org.pf4j.AbstractExtensionFinder

AbstractPluginManager - Class in org.pf4j

This class implements the boilerplate plugin code that any PluginManager implementation would have to support.

AbstractPluginManager() - Constructor for class org.pf4j.AbstractPluginManager

The plugins root is supplied by System.getProperty("pf4j.pluginsDir", "plugins").

AbstractPluginManager(Path) - Constructor for class org.pf4j.AbstractPluginManager

Constructs AbstractPluginManager with the given plugins root.

accept(File) - Method in class org.pf4j.util.AndFileFilter

accept(File) - Method in class org.pf4j.util.DirectoryFileFilter

accept(File) - Method in class org.pf4j.util.ExtensionFileFilter

accept(File) - Method in class org.pf4j.util.HiddenFilter

accept(File) - Method in class org.pf4j.util.NameFileFilter

accept(File) - Method in class org.pf4j.util.NotFileFilter

accept(File) - Method in class org.pf4j.util.OrFileFilter

add(ExtensionFinder) - Method in class org.pf4j.DefaultExtensionFinder

add(PluginDescriptorFinder) - Method in class org.pf4j.CompoundPluginDescriptorFinder

add(PluginLoader) - Method in class org.pf4j.CompoundPluginLoader

add(PluginLoader, BooleanSupplier) - Method in class org.pf4j.CompoundPluginLoader

Add a PluginLoader only if the condition is satisfied.

add(PluginRepository) - Method in class org.pf4j.CompoundPluginRepository

add(PluginRepository, BooleanSupplier) - Method in class org.pf4j.CompoundPluginRepository

Add a PluginRepository only if the condition is satisfied.

addClassesDirectories(String...) - Method in class org.pf4j.PluginClasspath

addClassesDirectories(Collection<String>) - Method in class org.pf4j.PluginClasspath

addDependency(PluginDependency) - Method in class org.pf4j.DefaultPluginDescriptor

addEdge(V, V) - Method in class org.pf4j.util.DirectedGraph

Add an edge to the graph; if either vertex does not exist, it's added.

addFile(File) - Method in class org.pf4j.PluginClassLoader

addFileFilter(FileFilter) - Method in class org.pf4j.util.AndFileFilter

addFileFilter(FileFilter) - Method in class org.pf4j.util.OrFileFilter

addJarsDirectories(String...) - Method in class org.pf4j.PluginClasspath

addJarsDirectories(Collection<String>) - Method in class org.pf4j.PluginClasspath

addPluginStateListener(PluginStateListener) - Method in class org.pf4j.AbstractPluginManager

addPluginStateListener(PluginStateListener) - Method in interface org.pf4j.PluginManager

addServiceProviderExtensionFinder() - Method in class org.pf4j.DefaultExtensionFinder

addStart(String, String) - Static method in class org.pf4j.util.StringUtils

Adds a substring only if the source string does not already start with the substring, otherwise returns the source string.

addURL(URL) - Method in class org.pf4j.PluginClassLoader

addVertex(V) - Method in class org.pf4j.util.DirectedGraph

Add a vertex to the graph.

AndFileFilter - Class in org.pf4j.util

This filter providing conditional AND logic across a list of file filters.

AndFileFilter() - Constructor for class org.pf4j.util.AndFileFilter

AndFileFilter(FileFilter...) - Constructor for class org.pf4j.util.AndFileFilter

AndFileFilter(List<FileFilter>) - Constructor for class org.pf4j.util.AndFileFilter

B

BasePluginLoader - Class in org.pf4j

Load all information needed by a plugin.

BasePluginLoader(PluginManager, PluginClasspath) - Constructor for class org.pf4j.BasePluginLoader

BasePluginRepository - Class in org.pf4j

BasePluginRepository(Path) - Constructor for class org.pf4j.BasePluginRepository

BasePluginRepository(Path, FileFilter) - Constructor for class org.pf4j.BasePluginRepository

byName(String) - Static method in enum org.pf4j.RuntimeMode

C

checkDependencyVersion(String, String) - Method in class org.pf4j.DependencyResolver

Check if an existing version of dependency is compatible with the required version (from plugin descriptor).

checkForExtensionDependencies - Variable in class org.pf4j.AbstractExtensionFinder

checkVersionConstraint(String, String) - Method in class org.pf4j.DefaultVersionManager

Checks if a version satisfies the specified SemVer Expression string.

checkVersionConstraint(String, String) - Method in interface org.pf4j.VersionManager

Check if a constraint and a version match.

CLASSES_DIR - Static variable in class org.pf4j.DefaultPluginClasspath

ClassUtils - Class in org.pf4j.util

ClassUtils() - Constructor for class org.pf4j.util.ClassUtils

comparator - Variable in class org.pf4j.BasePluginRepository

compareTo(ExtensionWrapper<T>) - Method in class org.pf4j.ExtensionWrapper

compareVersions(String, String) - Method in class org.pf4j.DefaultVersionManager

compareVersions(String, String) - Method in interface org.pf4j.VersionManager

Compare two versions.

CompoundPluginDescriptorFinder - Class in org.pf4j

CompoundPluginDescriptorFinder() - Constructor for class org.pf4j.CompoundPluginDescriptorFinder

CompoundPluginLoader - Class in org.pf4j

CompoundPluginLoader() - Constructor for class org.pf4j.CompoundPluginLoader

CompoundPluginRepository - Class in org.pf4j

CompoundPluginRepository() - Constructor for class org.pf4j.CompoundPluginRepository

containsVertex(V) - Method in class org.pf4j.util.DirectedGraph

True if graph contains vertex.

create(Class<T>) - Method in class org.pf4j.DefaultExtensionFactory

Creates an extension instance.

create(Class<T>) - Method in interface org.pf4j.ExtensionFactory

create(Class<T>) - Method in class org.pf4j.SingletonExtensionFactory

create(PluginWrapper) - Method in class org.pf4j.DefaultPluginFactory

Creates a plugin instance.

create(PluginWrapper) - Method in interface org.pf4j.PluginFactory

CREATED - org.pf4j.PluginState

The runtime knows the plugin is there.

createExtensionFactory() - Method in class org.pf4j.AbstractPluginManager

createExtensionFactory() - Method in class org.pf4j.DefaultPluginManager

createExtensionFinder() - Method in class org.pf4j.AbstractPluginManager

createExtensionFinder() - Method in class org.pf4j.DefaultPluginManager

createHiddenPluginFilter() - Method in class org.pf4j.DefaultPluginRepository

createHiddenPluginFilter() - Method in class org.pf4j.DevelopmentPluginRepository

createPluginClassLoader(Path, PluginDescriptor) - Method in class org.pf4j.BasePluginLoader

createPluginDescriptor(Manifest) - Method in class org.pf4j.ManifestPluginDescriptorFinder

createPluginDescriptor(Properties) - Method in class org.pf4j.PropertiesPluginDescriptorFinder

createPluginDescriptorFinder() - Method in class org.pf4j.AbstractPluginManager

createPluginDescriptorFinder() - Method in class org.pf4j.DefaultPluginManager

createPluginDescriptorFinder() - Method in class org.pf4j.JarPluginManager

createPluginDescriptorFinder() - Method in class org.pf4j.ZipPluginManager

createPluginDescriptorInstance() - Method in class org.pf4j.ManifestPluginDescriptorFinder

createPluginDescriptorInstance() - Method in class org.pf4j.PropertiesPluginDescriptorFinder

createPluginFactory() - Method in class org.pf4j.AbstractPluginManager

createPluginFactory() - Method in class org.pf4j.DefaultPluginManager

createPluginLoader() - Method in class org.pf4j.AbstractPluginManager

createPluginLoader() - Method in class org.pf4j.DefaultPluginManager

createPluginLoader() - Method in class org.pf4j.JarPluginManager

createPluginLoader() - Method in class org.pf4j.ZipPluginManager

createPluginRepository() - Method in class org.pf4j.AbstractPluginManager

createPluginRepository() - Method in class org.pf4j.DefaultPluginManager

createPluginRepository() - Method in class org.pf4j.JarPluginManager

createPluginRepository() - Method in class org.pf4j.ZipPluginManager

createPluginsRoot() - Method in class org.pf4j.AbstractPluginManager

Add the possibility to override the plugins root.

createPluginStatusProvider() - Method in class org.pf4j.AbstractPluginManager

createPluginStatusProvider() - Method in class org.pf4j.DefaultPluginManager

createVersionManager() - Method in class org.pf4j.AbstractPluginManager

createVersionManager() - Method in class org.pf4j.DefaultPluginManager

CyclicDependencyException() - Constructor for exception org.pf4j.DependencyResolver.CyclicDependencyException

D

debugExtensions(Set<String>) - Method in class org.pf4j.AbstractExtensionFinder

DEFAULT_PLUGINS_DIR - Static variable in class org.pf4j.AbstractPluginManager

DEFAULT_PROPERTIES_FILE_NAME - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

DefaultExtensionFactory - Class in org.pf4j

The default implementation for ExtensionFactory.

DefaultExtensionFactory() - Constructor for class org.pf4j.DefaultExtensionFactory

DefaultExtensionFinder - Class in org.pf4j

The default implementation for ExtensionFinder.

DefaultExtensionFinder(PluginManager) - Constructor for class org.pf4j.DefaultExtensionFinder

DefaultPluginClasspath - Class in org.pf4j

The default values are DefaultPluginClasspath.CLASSES_DIR and #LIB_DIR.

DefaultPluginClasspath() - Constructor for class org.pf4j.DefaultPluginClasspath

DefaultPluginDescriptor - Class in org.pf4j

DefaultPluginDescriptor() - Constructor for class org.pf4j.DefaultPluginDescriptor

DefaultPluginDescriptor(String, String, String, String, String, String, String) - Constructor for class org.pf4j.DefaultPluginDescriptor

DefaultPluginFactory - Class in org.pf4j

The default implementation for PluginFactory.

DefaultPluginFactory() - Constructor for class org.pf4j.DefaultPluginFactory

DefaultPluginLoader - Class in org.pf4j

Load all information needed by a plugin from DefaultPluginClasspath.

DefaultPluginLoader(PluginManager) - Constructor for class org.pf4j.DefaultPluginLoader

DefaultPluginManager - Class in org.pf4j

Default implementation of the PluginManager interface.

DefaultPluginManager() - Constructor for class org.pf4j.DefaultPluginManager

DefaultPluginManager(Path) - Constructor for class org.pf4j.DefaultPluginManager

DefaultPluginRepository - Class in org.pf4j

DefaultPluginRepository(Path) - Constructor for class org.pf4j.DefaultPluginRepository

DefaultPluginStatusProvider - Class in org.pf4j

The default implementation for PluginStatusProvider.

DefaultPluginStatusProvider(Path) - Constructor for class org.pf4j.DefaultPluginStatusProvider

DefaultVersionManager - Class in org.pf4j

Default implementation for VersionManager.

DefaultVersionManager() - Constructor for class org.pf4j.DefaultVersionManager

delete() - Method in class org.pf4j.Plugin

This method is called by the application when the plugin is deleted.

delete(Path) - Static method in class org.pf4j.util.FileUtils

Delete a file or recursively delete a folder, do not follow symlinks.

deletePlugin(String) - Method in class org.pf4j.AbstractPluginManager

deletePlugin(String) - Method in interface org.pf4j.PluginManager

Deletes a plugin.

deletePluginPath(Path) - Method in class org.pf4j.BasePluginRepository

deletePluginPath(Path) - Method in class org.pf4j.CompoundPluginRepository

deletePluginPath(Path) - Method in class org.pf4j.DefaultPluginRepository

deletePluginPath(Path) - Method in interface org.pf4j.PluginRepository

Removes a plugin from the repository.

DependenciesNotFoundException(List<String>) - Constructor for exception org.pf4j.DependencyResolver.DependenciesNotFoundException

DependenciesWrongVersionException(List<DependencyResolver.WrongDependencyVersion>) - Constructor for exception org.pf4j.DependencyResolver.DependenciesWrongVersionException

dependencyResolver - Variable in class org.pf4j.AbstractPluginManager

DependencyResolver - Class in org.pf4j

This class builds a dependency graph for a list of plugins (descriptors).

DependencyResolver(VersionManager) - Constructor for class org.pf4j.DependencyResolver

DependencyResolver.CyclicDependencyException - Exception in org.pf4j

It will be thrown if a cyclic dependency is detected.

DependencyResolver.DependenciesNotFoundException - Exception in org.pf4j

Indicates that the dependencies required were not found.

DependencyResolver.DependenciesWrongVersionException - Exception in org.pf4j

Indicates that some dependencies have wrong version.

DependencyResolver.Result - Class in org.pf4j

DependencyResolver.WrongDependencyVersion - Class in org.pf4j

DEPLOYMENT - org.pf4j.RuntimeMode

DEVELOPMENT - org.pf4j.RuntimeMode

DEVELOPMENT_PLUGINS_DIR - Static variable in class org.pf4j.AbstractPluginManager

DevelopmentPluginClasspath - Class in org.pf4j

It's a compound PluginClasspath (DevelopmentPluginClasspath.MAVEN + DevelopmentPluginClasspath.GRADLE + DevelopmentPluginClasspath.KOTLIN) used in development mode (RuntimeMode.DEVELOPMENT).

DevelopmentPluginClasspath() - Constructor for class org.pf4j.DevelopmentPluginClasspath

DevelopmentPluginLoader - Class in org.pf4j

Load all information needed by a plugin from DevelopmentPluginClasspath.

DevelopmentPluginLoader(PluginManager) - Constructor for class org.pf4j.DevelopmentPluginLoader

DevelopmentPluginRepository - Class in org.pf4j

DevelopmentPluginRepository(Path) - Constructor for class org.pf4j.DevelopmentPluginRepository

DirectedGraph<V> - Class in org.pf4j.util

See Wikipedia for more information.

DirectedGraph() - Constructor for class org.pf4j.util.DirectedGraph

DirectoryFileFilter - Class in org.pf4j.util

Filter accepts files that are directories.

DirectoryFileFilter() - Constructor for class org.pf4j.util.DirectoryFileFilter

DISABLED - org.pf4j.PluginState

The plugin cannot be used.

disablePlugin(String) - Method in class org.pf4j.AbstractPluginManager

disablePlugin(String) - Method in class org.pf4j.DefaultPluginStatusProvider

disablePlugin(String) - Method in interface org.pf4j.PluginManager

Disables a plugin from being loaded.

disablePlugin(String) - Method in interface org.pf4j.PluginStatusProvider

Disables a plugin from being loaded.

E

enablePlugin(String) - Method in class org.pf4j.AbstractPluginManager

enablePlugin(String) - Method in class org.pf4j.DefaultPluginStatusProvider

enablePlugin(String) - Method in interface org.pf4j.PluginManager

Enables a plugin that has previously been disabled.

enablePlugin(String) - Method in interface org.pf4j.PluginStatusProvider

Enables a plugin that has previously been disabled.

entries - Variable in class org.pf4j.AbstractExtensionFinder

equals(Object) - Method in class org.pf4j.PluginWrapper

equals(String) - Method in enum org.pf4j.PluginState

error(String, Object...) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

error(String, Object...) - Method in class org.pf4j.processor.ExtensionStorage

Helper method.

error(Element, String, Object...) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

error(Element, String, Object...) - Method in class org.pf4j.processor.ExtensionStorage

Helper method.

exactVersionAllowed - Variable in class org.pf4j.AbstractPluginManager

expandIfZip(Path) - Static method in class org.pf4j.util.FileUtils

Unzip a zip file in a directory that has the same name as the zip file.

Extension - Annotation Type in org.pf4j

ExtensionAnnotationProcessor - Class in org.pf4j.processor

ExtensionAnnotationProcessor() - Constructor for class org.pf4j.processor.ExtensionAnnotationProcessor

extensionClass - Variable in class org.pf4j.ExtensionDescriptor

ExtensionDescriptor - Class in org.pf4j

ExtensionDescriptor(int, Class<?>) - Constructor for class org.pf4j.ExtensionDescriptor

extensionFactory - Variable in class org.pf4j.AbstractPluginManager

ExtensionFactory - Interface in org.pf4j

Creates an extension instance.

ExtensionFileFilter - Class in org.pf4j.util

Filter accepts any file ending in extension.

ExtensionFileFilter(String) - Constructor for class org.pf4j.util.ExtensionFileFilter

extensionFinder - Variable in class org.pf4j.AbstractPluginManager

ExtensionFinder - Interface in org.pf4j

ExtensionInfo - Class in org.pf4j.asm

This class holds the parameters of an Extension annotation defined for a certain class.

extensionInfos - Variable in class org.pf4j.AbstractExtensionFinder

ExtensionPoint - Interface in org.pf4j

An extension point is a formal declaration in a plugin (or in application API) where customization is allowed.

EXTENSIONS_RESOURCE - Static variable in class org.pf4j.processor.LegacyExtensionStorage

EXTENSIONS_RESOURCE - Static variable in class org.pf4j.processor.ServiceProviderExtensionStorage

ExtensionStorage - Class in org.pf4j.processor

ExtensionStorage(ExtensionAnnotationProcessor) - Constructor for class org.pf4j.processor.ExtensionStorage

ExtensionWrapper<T> - Class in org.pf4j

A wrapper over extension instance.

ExtensionWrapper(ExtensionDescriptor, ExtensionFactory) - Constructor for class org.pf4j.ExtensionWrapper

extract() - Method in class org.pf4j.util.Unzip

Extract the content of zip file (source) to destination directory.

F

FileUtils - Class in org.pf4j.util

FileUtils() - Constructor for class org.pf4j.util.FileUtils

filter - Variable in class org.pf4j.BasePluginRepository

find(Class<T>) - Method in class org.pf4j.AbstractExtensionFinder

find(Class<T>) - Method in class org.pf4j.DefaultExtensionFinder

find(Class<T>) - Method in interface org.pf4j.ExtensionFinder

Retrieves a list with all extensions found for an extension point.

find(Class<T>, String) - Method in class org.pf4j.AbstractExtensionFinder

find(Class<T>, String) - Method in class org.pf4j.DefaultExtensionFinder

find(Class<T>, String) - Method in interface org.pf4j.ExtensionFinder

Retrieves a list with all extensions found for an extension point and a plugin.

find(String) - Method in class org.pf4j.AbstractExtensionFinder

find(String) - Method in class org.pf4j.DefaultExtensionFinder

find(String) - Method in interface org.pf4j.ExtensionFinder

Retrieves a list with all extensions found for a plugin

find(Path) - Method in class org.pf4j.CompoundPluginDescriptorFinder

find(Path) - Method in class org.pf4j.ManifestPluginDescriptorFinder

find(Path) - Method in interface org.pf4j.PluginDescriptorFinder

find(Path) - Method in class org.pf4j.PropertiesPluginDescriptorFinder

findClassNames(String) - Method in class org.pf4j.AbstractExtensionFinder

findClassNames(String) - Method in class org.pf4j.DefaultExtensionFinder

findClassNames(String) - Method in interface org.pf4j.ExtensionFinder

Retrieves a list with all extension class names found for a plugin.

finders - Variable in class org.pf4j.DefaultExtensionFinder

findFile(Path, String) - Static method in class org.pf4j.util.FileUtils

findWithEnding(Path, String...) - Static method in class org.pf4j.util.FileUtils

Finds a path with various endings or null if not found.

firePluginStateEvent(PluginStateEvent) - Method in class org.pf4j.AbstractPluginManager

format(String, Object...) - Static method in class org.pf4j.util.StringUtils

Format the string.

G

getAllInterfaces(Class<?>) - Static method in class org.pf4j.util.ClassUtils

getAllInterfacesNames(Class<?>) - Static method in class org.pf4j.util.ClassUtils

getAnnotationMirror(TypeElement, Class<?>) - Static method in class org.pf4j.util.ClassUtils

Get a certain annotation of a TypeElement.

getAnnotationValue(AnnotationMirror, String) - Static method in class org.pf4j.util.ClassUtils

Get a certain parameter of an AnnotationMirror.

getAnnotationValue(TypeElement, Class<?>, String) - Static method in class org.pf4j.util.ClassUtils

Get a certain annotation parameter of a TypeElement.

getBinaryName(TypeElement) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getClassesDirectories() - Method in class org.pf4j.PluginClasspath

getClassName() - Method in class org.pf4j.asm.ExtensionInfo

Get the name of the class, for which extension info was created.

getDependencies() - Method in class org.pf4j.DefaultPluginDescriptor

Returns all dependencies declared by this plugin.

getDependencies() - Method in exception org.pf4j.DependencyResolver.DependenciesNotFoundException

getDependencies() - Method in exception org.pf4j.DependencyResolver.DependenciesWrongVersionException

getDependencies() - Method in interface org.pf4j.PluginDescriptor

getDependencies(String) - Method in class org.pf4j.DependencyResolver

Retrieves the plugins ids that the given plugin id directly depends on.

getDependencyId() - Method in class org.pf4j.DependencyResolver.WrongDependencyVersion

getDependentId() - Method in class org.pf4j.DependencyResolver.WrongDependencyVersion

getDependents(String) - Method in class org.pf4j.DependencyResolver

Retrieves the plugins ids that the given content is a direct dependency of.

getDescriptor() - Method in class org.pf4j.ExtensionWrapper

getDescriptor() - Method in class org.pf4j.PluginWrapper

Returns the plugin descriptor.

getDisabledFilePath() - Method in class org.pf4j.DefaultPluginStatusProvider

getDisabledFilePath(Path) - Static method in class org.pf4j.DefaultPluginStatusProvider

getEnabledFilePath() - Method in class org.pf4j.DefaultPluginStatusProvider

getEnabledFilePath(Path) - Static method in class org.pf4j.DefaultPluginStatusProvider

getExistingVersion() - Method in class org.pf4j.DependencyResolver.WrongDependencyVersion

getExtension() - Method in class org.pf4j.ExtensionWrapper

getExtensionClasses(Class<T>) - Method in class org.pf4j.AbstractPluginManager

getExtensionClasses(Class<T>) - Method in interface org.pf4j.PluginManager

getExtensionClasses(Class<T>, String) - Method in class org.pf4j.AbstractPluginManager

getExtensionClasses(Class<T>, String) - Method in interface org.pf4j.PluginManager

getExtensionClasses(String) - Method in class org.pf4j.AbstractPluginManager

getExtensionClasses(String) - Method in interface org.pf4j.PluginManager

getExtensionClassNames(String) - Method in class org.pf4j.AbstractPluginManager

getExtensionClassNames(String) - Method in interface org.pf4j.PluginManager

getExtensionFactory() - Method in class org.pf4j.AbstractPluginManager

getExtensionFactory() - Method in interface org.pf4j.PluginManager

getExtensions() - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getExtensions(Class<T>) - Method in class org.pf4j.AbstractPluginManager

getExtensions(Class<T>) - Method in interface org.pf4j.PluginManager

getExtensions(Class<T>, String) - Method in class org.pf4j.AbstractPluginManager

getExtensions(Class<T>, String) - Method in interface org.pf4j.PluginManager

getExtensions(String) - Method in class org.pf4j.AbstractPluginManager

getExtensions(String) - Method in interface org.pf4j.PluginManager

getFileFilters() - Method in class org.pf4j.util.AndFileFilter

getFileFilters() - Method in class org.pf4j.util.OrFileFilter

getFiler() - Method in class org.pf4j.processor.ExtensionStorage

Helper method.

getJars(Path) - Static method in class org.pf4j.util.FileUtils

getJarsDirectories() - Method in class org.pf4j.PluginClasspath

getLicense() - Method in class org.pf4j.DefaultPluginDescriptor

Returns the legal license of this plugin, e.g.

getLicense() - Method in interface org.pf4j.PluginDescriptor

getManifestPath(Path) - Method in class org.pf4j.ManifestPluginDescriptorFinder

getNeighbors(V) - Method in class org.pf4j.util.DirectedGraph

getNotFoundDependencies() - Method in class org.pf4j.DependencyResolver.Result

Returns a list with dependencies required that were not found.

getOldExtensions() - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getOldState() - Method in class org.pf4j.PluginStateEvent

getOrdinal() - Method in class org.pf4j.asm.ExtensionInfo

Get the Extension.ordinal() value, that was assigned to the extension.

getOrdinal() - Method in class org.pf4j.ExtensionWrapper

getPath(URI, String, String...) - Static method in class org.pf4j.util.FileUtils

getPath(Path, String, String...) - Static method in class org.pf4j.util.FileUtils

getPlugin() - Method in class org.pf4j.PluginStateEvent

getPlugin() - Method in class org.pf4j.PluginWrapper

getPlugin(String) - Method in class org.pf4j.AbstractPluginManager

getPlugin(String) - Method in interface org.pf4j.PluginManager

Retrieves the plugin with this id, or null if the plugin does not exist.

getPluginClass() - Method in class org.pf4j.DefaultPluginDescriptor

Returns the name of the class that implements Plugin interface.

getPluginClass() - Method in interface org.pf4j.PluginDescriptor

getPluginClassLoader() - Method in class org.pf4j.PluginWrapper

Returns the plugin class loader used to load classes and resources for this plug-in.

getPluginClassLoader(String) - Method in class org.pf4j.AbstractPluginManager

Get the ClassLoader for plugin.

getPluginClassLoader(String) - Method in interface org.pf4j.PluginManager

getPluginClassLoaders() - Method in class org.pf4j.AbstractPluginManager

getPluginDescription() - Method in class org.pf4j.DefaultPluginDescriptor

Returns the description of this plugin.

getPluginDescription() - Method in interface org.pf4j.PluginDescriptor

getPluginDescriptorFinder() - Method in class org.pf4j.AbstractPluginManager

getPluginFactory() - Method in class org.pf4j.AbstractPluginManager

getPluginId() - Method in class org.pf4j.DefaultPluginDescriptor

Returns the unique identifier of this plugin.

getPluginId() - Method in exception org.pf4j.PluginAlreadyLoadedException

getPluginId() - Method in class org.pf4j.PluginDependency

getPluginId() - Method in interface org.pf4j.PluginDescriptor

getPluginId() - Method in class org.pf4j.PluginWrapper

Shortcut

getPluginLabel(PluginDescriptor) - Method in class org.pf4j.AbstractPluginManager

The plugin label is used in logging and it's a string in format pluginId@pluginVersion.

getPluginLoader() - Method in class org.pf4j.AbstractPluginManager

getPluginManager() - Method in class org.pf4j.PluginWrapper

Returns the plugin manager.

getPluginPath() - Method in exception org.pf4j.PluginAlreadyLoadedException

getPluginPath() - Method in class org.pf4j.PluginWrapper

Returns the path of this plugin.

getPluginPaths() - Method in class org.pf4j.BasePluginRepository

getPluginPaths() - Method in class org.pf4j.CompoundPluginRepository

getPluginPaths() - Method in class org.pf4j.DefaultPluginRepository

getPluginPaths() - Method in interface org.pf4j.PluginRepository

List all plugin paths.

getPlugins() - Method in class org.pf4j.AbstractPluginManager

Returns a copy of plugins.

getPlugins() - Method in class org.pf4j.asm.ExtensionInfo

Get the Extension.plugins() value, that was assigned to the extension.

getPlugins() - Method in interface org.pf4j.PluginManager

Retrieves all plugins.

getPlugins(PluginState) - Method in class org.pf4j.AbstractPluginManager

Returns a copy of plugins with that state.

getPlugins(PluginState) - Method in interface org.pf4j.PluginManager

Retrieves all plugins with this state.

getPluginsRoot() - Method in class org.pf4j.AbstractPluginManager

getPluginsRoot() - Method in interface org.pf4j.PluginManager

Gets the path of the folder where plugins are installed.

getPluginState() - Method in class org.pf4j.PluginStateEvent

getPluginState() - Method in class org.pf4j.PluginWrapper

getPluginVersionSupport() - Method in class org.pf4j.PluginDependency

getPoints() - Method in class org.pf4j.asm.ExtensionInfo

Get the Extension.points() value, that was assigned to the extension.

getProcessingEnvironment() - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getPropertiesPath(Path, String) - Method in class org.pf4j.PropertiesPluginDescriptorFinder

getProvider() - Method in class org.pf4j.DefaultPluginDescriptor

Returns the provider name of this plugin.

getProvider() - Method in interface org.pf4j.PluginDescriptor

getRequiredVersion() - Method in class org.pf4j.DependencyResolver.WrongDependencyVersion

getRequires() - Method in class org.pf4j.DefaultPluginDescriptor

Returns string version of requires

getRequires() - Method in interface org.pf4j.PluginDescriptor

getResolvedPlugins() - Method in class org.pf4j.AbstractPluginManager

getResolvedPlugins() - Method in interface org.pf4j.PluginManager

Retrieves all resolved plugins (with resolved dependency).

getResource(String) - Method in class org.pf4j.PluginClassLoader

Load the named resource from this plugin.

getResources(String) - Method in class org.pf4j.PluginClassLoader

getRuntimeMode() - Method in class org.pf4j.AbstractPluginManager

getRuntimeMode() - Method in interface org.pf4j.PluginManager

The runtime mode.

getRuntimeMode() - Method in class org.pf4j.PluginWrapper

getSortedPlugins() - Method in class org.pf4j.DependencyResolver.Result

Get the list of plugins in dependency sorted order.

getSource() - Method in class org.pf4j.PluginStateEvent

getStartedPlugins() - Method in class org.pf4j.AbstractPluginManager

getStartedPlugins() - Method in interface org.pf4j.PluginManager

Retrieves all started plugins.

getSupportedAnnotationTypes() - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getSupportedOptions() - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getSupportedSourceVersion() - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

getSystemVersion() - Method in class org.pf4j.AbstractPluginManager

getSystemVersion() - Method in interface org.pf4j.PluginManager

Returns the system version.

getUnresolvedPlugins() - Method in class org.pf4j.AbstractPluginManager

getUnresolvedPlugins() - Method in interface org.pf4j.PluginManager

Retrieves all unresolved plugins (with unresolved dependency).

getVersion() - Method in class org.pf4j.AbstractPluginManager

getVersion() - Method in class org.pf4j.DefaultPluginDescriptor

Returns the version of this plugin.

getVersion() - Method in interface org.pf4j.PluginDescriptor

getVersionManager() - Method in class org.pf4j.AbstractPluginManager

getVersionManager() - Method in interface org.pf4j.PluginManager

getWrapper() - Method in class org.pf4j.Plugin

Retrieves the wrapper of this plug-in.

getWrongVersionDependencies() - Method in class org.pf4j.DependencyResolver.Result

Returns a list with dependencies with wrong version.

GRADLE - Static variable in class org.pf4j.DevelopmentPluginClasspath

The development plugin classpath for Gradle.

GRADLE_BUILD_DIR - Static variable in class org.pf4j.DevelopmentPluginRepository

H

hasCyclicDependency() - Method in class org.pf4j.DependencyResolver.Result

Returns true is a cyclic dependency was detected.

hashCode() - Method in class org.pf4j.PluginWrapper

HiddenFilter - Class in org.pf4j.util

Filter that only accepts hidden files.

HiddenFilter() - Constructor for class org.pf4j.util.HiddenFilter

I

IDEA - Static variable in class org.pf4j.DevelopmentPluginClasspath

The development plugin classpath for IDEA.

idForPath(Path) - Method in class org.pf4j.AbstractPluginManager

Tests for already loaded plugins on given path.

inDegree() - Method in class org.pf4j.util.DirectedGraph

Report (as a Map) the in-degree (the number of head ends adjacent to a vertex) of each vertex.

info(String, Object...) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

info(String, Object...) - Method in class org.pf4j.processor.ExtensionStorage

Helper method.

info(Element, String, Object...) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

info(Element, String, Object...) - Method in class org.pf4j.processor.ExtensionStorage

Helper method.

init(ProcessingEnvironment) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

initialize() - Method in class org.pf4j.AbstractPluginManager

initialize() - Method in class org.pf4j.DefaultPluginManager

isApplicable(Path) - Method in class org.pf4j.BasePluginLoader

isApplicable(Path) - Method in class org.pf4j.CompoundPluginDescriptorFinder

isApplicable(Path) - Method in class org.pf4j.CompoundPluginLoader

isApplicable(Path) - Method in class org.pf4j.DefaultPluginLoader

isApplicable(Path) - Method in class org.pf4j.JarPluginLoader

isApplicable(Path) - Method in class org.pf4j.ManifestPluginDescriptorFinder

isApplicable(Path) - Method in interface org.pf4j.PluginDescriptorFinder

Returns true if this finder is applicable to the given Path.

isApplicable(Path) - Method in interface org.pf4j.PluginLoader

Returns true if this loader is applicable to the given Path.

isApplicable(Path) - Method in class org.pf4j.PropertiesPluginDescriptorFinder

isCheckForExtensionDependencies() - Method in class org.pf4j.AbstractExtensionFinder

Returns true, if the extension finder checks extensions for its required plugins.

isDag() - Method in class org.pf4j.util.DirectedGraph

True if graph is a dag (directed acyclic graph).

isDevelopment() - Method in interface org.pf4j.PluginManager

Returns true if the runtime mode is RuntimeMode.DEVELOPMENT.

isExactVersionAllowed() - Method in class org.pf4j.AbstractPluginManager

isJarFile(Path) - Static method in class org.pf4j.util.FileUtils

Return true only if path is a jar file.

isNotDevelopment() - Method in interface org.pf4j.PluginManager

Returns true if the runtime mode is not RuntimeMode.DEVELOPMENT.

isNotNullOrEmpty(String) - Static method in class org.pf4j.util.StringUtils

isNullOrEmpty(String) - Static method in class org.pf4j.util.StringUtils

isOptional() - Method in class org.pf4j.PluginDependency

isPluginDisabled(String) - Method in class org.pf4j.AbstractPluginManager

isPluginDisabled(String) - Method in class org.pf4j.DefaultPluginStatusProvider

isPluginDisabled(String) - Method in interface org.pf4j.PluginStatusProvider

Checks if the plugin is disabled or not

isPluginValid(PluginWrapper) - Method in class org.pf4j.AbstractPluginManager

Check if this plugin is valid (satisfies "requires" param) for a given system version.

isZipFile(Path) - Static method in class org.pf4j.util.FileUtils

Return true only if path is a zip file.

J

JarFileFilter - Class in org.pf4j.util

File filter that accepts all files ending with .JAR.

JarFileFilter() - Constructor for class org.pf4j.util.JarFileFilter

JarPluginLoader - Class in org.pf4j

JarPluginLoader(PluginManager) - Constructor for class org.pf4j.JarPluginLoader

JarPluginManager - Class in org.pf4j

It's a PluginManager that loads each plugin from a jar file.

JarPluginManager() - Constructor for class org.pf4j.JarPluginManager

JarPluginManager(Path) - Constructor for class org.pf4j.JarPluginManager

JarPluginRepository - Class in org.pf4j

JarPluginRepository(Path) - Constructor for class org.pf4j.JarPluginRepository

K

KOTLIN - Static variable in class org.pf4j.DevelopmentPluginClasspath

The development plugin classpath for Kotlin.

L

LegacyExtensionFinder - Class in org.pf4j

All extensions declared in a plugin are indexed in a file META-INF/extensions.idx.

LegacyExtensionFinder(PluginManager) - Constructor for class org.pf4j.LegacyExtensionFinder

LegacyExtensionStorage - Class in org.pf4j.processor

LegacyExtensionStorage(ExtensionAnnotationProcessor) - Constructor for class org.pf4j.processor.LegacyExtensionStorage

LIB_DIR - Static variable in class org.pf4j.DefaultPluginClasspath

load(String, ClassLoader) - Static method in class org.pf4j.asm.ExtensionInfo

Load an ExtensionInfo for a certain class.

loadClass(String) - Method in class org.pf4j.PluginClassLoader

By default, it uses a child first delegation model rather than the standard parent first.

loadClasses(Path, PluginClassLoader) - Method in class org.pf4j.BasePluginLoader

Add all *.class files from PluginClasspath.getClassesDirectories() to the plugin's ClassLoader.

loadJars(Path, PluginClassLoader) - Method in class org.pf4j.BasePluginLoader

Add all *.jar files from PluginClasspath.getJarsDirectories() to the plugin's ClassLoader.

loadPlugin(Path) - Method in class org.pf4j.AbstractPluginManager

loadPlugin(Path) - Method in interface org.pf4j.PluginManager

Load a plugin.

loadPlugin(Path, PluginDescriptor) - Method in class org.pf4j.BasePluginLoader

loadPlugin(Path, PluginDescriptor) - Method in class org.pf4j.CompoundPluginLoader

loadPlugin(Path, PluginDescriptor) - Method in class org.pf4j.JarPluginLoader

loadPlugin(Path, PluginDescriptor) - Method in interface org.pf4j.PluginLoader

loadPluginFromPath(Path) - Method in class org.pf4j.AbstractPluginManager

loadPluginFromPath(Path) - Method in class org.pf4j.DefaultPluginManager

Load a plugin from disk.

loadPlugins() - Method in class org.pf4j.AbstractPluginManager

Load plugins.

loadPlugins() - Method in interface org.pf4j.PluginManager

Load plugins.

log - Variable in class org.pf4j.Plugin

Makes logging service available for descending classes.

LoggingPluginStateListener - Class in org.pf4j

It's an implementation of PluginStateListener that writes all events to logger (DEBUG level).

LoggingPluginStateListener() - Constructor for class org.pf4j.LoggingPluginStateListener

M

ManifestPluginDescriptorFinder - Class in org.pf4j

Read the plugin descriptor from the manifest file.

ManifestPluginDescriptorFinder() - Constructor for class org.pf4j.ManifestPluginDescriptorFinder

MAVEN - Static variable in class org.pf4j.DevelopmentPluginClasspath

The development plugin classpath for Maven.

MAVEN_BUILD_DIR - Static variable in class org.pf4j.DevelopmentPluginRepository

MODE_PROPERTY_NAME - Static variable in class org.pf4j.AbstractPluginManager

N

NameFileFilter - Class in org.pf4j.util

Filter accepts any file with this name.

NameFileFilter(String) - Constructor for class org.pf4j.util.NameFileFilter

NotFileFilter - Class in org.pf4j.util

This filter produces a logical NOT of the filters specified.

NotFileFilter(FileFilter) - Constructor for class org.pf4j.util.NotFileFilter

O

optimisticDelete(Path) - Static method in class org.pf4j.util.FileUtils

Delete a file (not recursively) and ignore any errors.

ordinal - Variable in class org.pf4j.ExtensionDescriptor

ordinal() - Method in annotation type org.pf4j.Extension

OrFileFilter - Class in org.pf4j.util

This filter providing conditional OR logic across a list of file filters.

OrFileFilter() - Constructor for class org.pf4j.util.OrFileFilter

OrFileFilter(FileFilter...) - Constructor for class org.pf4j.util.OrFileFilter

OrFileFilter(List<FileFilter>) - Constructor for class org.pf4j.util.OrFileFilter

org.pf4j - module org.pf4j

Module descriptor for PF4J.

org.pf4j - package org.pf4j

org.pf4j.asm - package org.pf4j.asm

org.pf4j.processor - package org.pf4j.processor

org.pf4j.util - package org.pf4j.util

outDegree() - Method in class org.pf4j.util.DirectedGraph

Report (as a Map) the out-degree (the number of tail ends adjacent to a vertex) of each vertex.

P

parse(String) - Static method in enum org.pf4j.PluginState

Plugin - Class in org.pf4j

This class will be extended by all plugins and serve as the common class between a plugin and the application.

Plugin(PluginWrapper) - Constructor for class org.pf4j.Plugin

Constructor to be used by plugin manager for plugin instantiation.

PLUGIN_CLASS - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_CLASS - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_DEPENDENCIES - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_DEPENDENCIES - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_DESCRIPTION - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_DESCRIPTION - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_ID - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_ID - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_LICENSE - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_LICENSE - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_PROVIDER - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_PROVIDER - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_REQUIRES - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_REQUIRES - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PLUGIN_VERSION - Static variable in class org.pf4j.ManifestPluginDescriptorFinder

PLUGIN_VERSION - Static variable in class org.pf4j.PropertiesPluginDescriptorFinder

PluginAlreadyLoadedException - Exception in org.pf4j

PluginAlreadyLoadedException(String, Path) - Constructor for exception org.pf4j.PluginAlreadyLoadedException

PluginClassLoader - Class in org.pf4j

One instance of this class should be created by plugin manager for every available plug-in.

PluginClassLoader(PluginManager, PluginDescriptor, ClassLoader) - Constructor for class org.pf4j.PluginClassLoader

PluginClassLoader(PluginManager, PluginDescriptor, ClassLoader, boolean) - Constructor for class org.pf4j.PluginClassLoader

If parentFirst is true, indicates that the parent ClassLoader should be consulted before trying to load the a class through this loader.

pluginClassLoaders - Variable in class org.pf4j.AbstractPluginManager

A map of plugin class loaders (the key is the 'pluginId').

pluginClasspath - Variable in class org.pf4j.BasePluginLoader

PluginClasspath - Class in org.pf4j

The classpath of the plugin.

PluginClasspath() - Constructor for class org.pf4j.PluginClasspath

PluginDependency - Class in org.pf4j

PluginDependency(String) - Constructor for class org.pf4j.PluginDependency

PluginDescriptor - Interface in org.pf4j

A plugin descriptor contains information about a plug-in.

pluginDescriptorFinder - Variable in class org.pf4j.AbstractPluginManager

PluginDescriptorFinder - Interface in org.pf4j

Find a plugin descriptor for a plugin path.

pluginFactory - Variable in class org.pf4j.AbstractPluginManager

PluginFactory - Interface in org.pf4j

Creates a plugin instance.

pluginLoader - Variable in class org.pf4j.AbstractPluginManager

PluginLoader - Interface in org.pf4j

Load all information (classes) needed by a plugin.

pluginManager - Variable in class org.pf4j.AbstractExtensionFinder

pluginManager - Variable in class org.pf4j.BasePluginLoader

pluginManager - Variable in class org.pf4j.DefaultExtensionFinder

pluginManager - Variable in class org.pf4j.JarPluginLoader

PluginManager - Interface in org.pf4j

Provides the functionality for plugin management such as load, start and stop the plugins.

pluginRepository - Variable in class org.pf4j.AbstractPluginManager

PluginRepository - Interface in org.pf4j

Directory that contains plugins.

PluginRuntimeException - Exception in org.pf4j

An exception used to indicate that a plugin problem occurred.

PluginRuntimeException() - Constructor for exception org.pf4j.PluginRuntimeException

PluginRuntimeException(String) - Constructor for exception org.pf4j.PluginRuntimeException

PluginRuntimeException(String, Object...) - Constructor for exception org.pf4j.PluginRuntimeException

PluginRuntimeException(Throwable) - Constructor for exception org.pf4j.PluginRuntimeException

PluginRuntimeException(Throwable, String, Object...) - Constructor for exception org.pf4j.PluginRuntimeException

plugins - Variable in class org.pf4j.AbstractPluginManager

A map of plugins this manager is responsible for (the key is the 'pluginId').

plugins() - Method in annotation type org.pf4j.Extension

An array of plugin IDs, that have to be available in order to load this extension.

PLUGINS_DIR_CONFIG_PROPERTY_NAME - Static variable in class org.pf4j.DefaultPluginManager

PLUGINS_DIR_PROPERTY_NAME - Static variable in class org.pf4j.AbstractPluginManager

pluginsRoot - Variable in class org.pf4j.AbstractPluginManager

pluginsRoot - Variable in class org.pf4j.BasePluginRepository

PluginState - Enum in org.pf4j

pluginStateChanged(PluginStateEvent) - Method in class org.pf4j.AbstractExtensionFinder

pluginStateChanged(PluginStateEvent) - Method in class org.pf4j.DefaultExtensionFinder

pluginStateChanged(PluginStateEvent) - Method in class org.pf4j.LoggingPluginStateListener

pluginStateChanged(PluginStateEvent) - Method in interface org.pf4j.PluginStateListener

Invoked when a plugin's state (for example DISABLED, STARTED) is changed.

PluginStateEvent - Class in org.pf4j

PluginStateEvent(PluginManager, PluginWrapper, PluginState) - Constructor for class org.pf4j.PluginStateEvent

PluginStateListener - Interface in org.pf4j

PluginStateListener defines the interface for an object that listens to plugin state changes.

pluginStateListeners - Variable in class org.pf4j.AbstractPluginManager

The registered PluginStateListeners.

pluginStatusProvider - Variable in class org.pf4j.AbstractPluginManager

PluginStatusProvider - Interface in org.pf4j

PluginWrapper - Class in org.pf4j

A wrapper over plugin instance.

PluginWrapper(PluginManager, PluginDescriptor, Path, ClassLoader) - Constructor for class org.pf4j.PluginWrapper

points() - Method in annotation type org.pf4j.Extension

An array of extension points, that are implemented by this extension.

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.pf4j.processor.ExtensionAnnotationProcessor

processor - Variable in class org.pf4j.processor.ExtensionStorage

propertiesFileName - Variable in class org.pf4j.PropertiesPluginDescriptorFinder

PropertiesPluginDescriptorFinder - Class in org.pf4j

Find a plugin descriptor in a properties file (in plugin repository).

PropertiesPluginDescriptorFinder() - Constructor for class org.pf4j.PropertiesPluginDescriptorFinder

PropertiesPluginDescriptorFinder(String) - Constructor for class org.pf4j.PropertiesPluginDescriptorFinder

R

read() - Method in class org.pf4j.processor.ExtensionStorage

read() - Method in class org.pf4j.processor.LegacyExtensionStorage

read() - Method in class org.pf4j.processor.ServiceProviderExtensionStorage

read(Reader, Set<String>) - Static method in class org.pf4j.processor.LegacyExtensionStorage

read(Reader, Set<String>) - Static method in class org.pf4j.processor.ServiceProviderExtensionStorage

readClasspathStorages() - Method in class org.pf4j.AbstractExtensionFinder

readClasspathStorages() - Method in class org.pf4j.LegacyExtensionFinder

readClasspathStorages() - Method in class org.pf4j.ServiceProviderExtensionFinder

readLines(Path, boolean) - Static method in class org.pf4j.util.FileUtils

readManifest(Path) - Method in class org.pf4j.ManifestPluginDescriptorFinder

readPluginsStorages() - Method in class org.pf4j.AbstractExtensionFinder

readPluginsStorages() - Method in class org.pf4j.LegacyExtensionFinder

readPluginsStorages() - Method in class org.pf4j.ServiceProviderExtensionFinder

readProperties(Path) - Method in class org.pf4j.PropertiesPluginDescriptorFinder

removeEdge(V, V) - Method in class org.pf4j.util.DirectedGraph

Remove an edge from the graph.

removeFileFilter(FileFilter) - Method in class org.pf4j.util.AndFileFilter

removeFileFilter(FileFilter) - Method in class org.pf4j.util.OrFileFilter

removePluginStateListener(PluginStateListener) - Method in class org.pf4j.AbstractPluginManager

removePluginStateListener(PluginStateListener) - Method in interface org.pf4j.PluginManager

removeVertex(V) - Method in class org.pf4j.util.DirectedGraph

resolve(List<PluginDescriptor>) - Method in class org.pf4j.DependencyResolver

RESOLVED - org.pf4j.PluginState

The plugin is created.

resolvedPlugins - Variable in class org.pf4j.AbstractPluginManager

A list with all resolved plugins (resolved dependency).

resolvePlugins() - Method in class org.pf4j.AbstractPluginManager

reverseTopologicalSort() - Method in class org.pf4j.util.DirectedGraph

Report (as a List) the reverse topological sort of the vertices; null for no such sort.

runtimeMode - Variable in class org.pf4j.AbstractPluginManager

Cache value for the runtime mode.

RuntimeMode - Enum in org.pf4j

S

ServiceProviderExtensionFinder - Class in org.pf4j

The ServiceLoader base implementation for ExtensionFinder.

ServiceProviderExtensionFinder(PluginManager) - Constructor for class org.pf4j.ServiceProviderExtensionFinder

ServiceProviderExtensionStorage - Class in org.pf4j.processor

ServiceProviderExtensionStorage(ExtensionAnnotationProcessor) - Constructor for class org.pf4j.processor.ServiceProviderExtensionStorage

setCheckForExtensionDependencies(boolean) - Method in class org.pf4j.AbstractExtensionFinder

Plugin developers may enable / disable checks for required plugins of an extension.

setComparator(Comparator<File>) - Method in class org.pf4j.BasePluginRepository

Set a File Comparator used to sort the listed files from pluginsRoot.

setDependencies(String) - Method in class org.pf4j.DefaultPluginDescriptor

setDestination(File) - Method in class org.pf4j.util.Unzip

setExactVersionAllowed(boolean) - Method in class org.pf4j.AbstractPluginManager

Set to true to allow requires expression to be exactly x.y.z.

setFileFilters(List<FileFilter>) - Method in class org.pf4j.util.AndFileFilter

setFileFilters(List<FileFilter>) - Method in class org.pf4j.util.OrFileFilter

setFilter(FileFilter) - Method in class org.pf4j.BasePluginRepository

setLicense(String) - Method in class org.pf4j.DefaultPluginDescriptor

setPluginClass(String) - Method in class org.pf4j.DefaultPluginDescriptor

setPluginDescription(String) - Method in class org.pf4j.DefaultPluginDescriptor

setPluginFactory(PluginFactory) - Method in class org.pf4j.PluginWrapper

setPluginId(String) - Method in class org.pf4j.DefaultPluginDescriptor

setPluginState(PluginState) - Method in class org.pf4j.PluginWrapper

setPluginVersion(String) - Method in class org.pf4j.DefaultPluginDescriptor

setProvider(String) - Method in class org.pf4j.DefaultPluginDescriptor

setRequires(String) - Method in class org.pf4j.DefaultPluginDescriptor

setSource(File) - Method in class org.pf4j.util.Unzip

setSystemVersion(String) - Method in class org.pf4j.AbstractPluginManager

setSystemVersion(String) - Method in interface org.pf4j.PluginManager

Set the system version.

SingletonExtensionFactory - Class in org.pf4j

An ExtensionFactory that always returns a specific instance.

SingletonExtensionFactory(String...) - Constructor for class org.pf4j.SingletonExtensionFactory

size() - Method in class org.pf4j.CompoundPluginDescriptorFinder

size() - Method in class org.pf4j.CompoundPluginLoader

start() - Method in class org.pf4j.Plugin

This method is called by the application when the plugin is started.

STARTED - org.pf4j.PluginState

The Plugin.start() has executed.

startedPlugins - Variable in class org.pf4j.AbstractPluginManager

A list with started plugins.

startPlugin(String) - Method in class org.pf4j.AbstractPluginManager

Start the specified plugin and its dependencies.

startPlugin(String) - Method in interface org.pf4j.PluginManager

Start the specified plugin and its dependencies.

startPlugins() - Method in class org.pf4j.AbstractPluginManager

Start all active plugins.

startPlugins() - Method in interface org.pf4j.PluginManager

Start all active plugins.

stop() - Method in class org.pf4j.Plugin

This method is called by the application when the plugin is stopped.

STOPPED - org.pf4j.PluginState

The Plugin.stop() has executed.

stopPlugin(String) - Method in class org.pf4j.AbstractPluginManager

Stop the specified plugin and it's dependents.

stopPlugin(String) - Method in interface org.pf4j.PluginManager

Stop the specified plugin and its dependencies.

stopPlugins() - Method in class org.pf4j.AbstractPluginManager

Stop all active plugins.

stopPlugins() - Method in interface org.pf4j.PluginManager

Stop all active plugins.

StringUtils - Class in org.pf4j.util

StringUtils() - Constructor for class org.pf4j.util.StringUtils

systemVersion - Variable in class org.pf4j.AbstractPluginManager

The system version used for comparisons to the plugin requires attribute.

T

topologicalSort() - Method in class org.pf4j.util.DirectedGraph

Report (as a List) the topological sort of the vertices; null for no such sort.

toString() - Method in class org.pf4j.DefaultPluginDescriptor

toString() - Method in class org.pf4j.PluginDependency

toString() - Method in enum org.pf4j.PluginState

toString() - Method in class org.pf4j.PluginStateEvent

toString() - Method in class org.pf4j.PluginWrapper

toString() - Method in enum org.pf4j.RuntimeMode

toString() - Method in class org.pf4j.util.DirectedGraph

String representation of graph.

U

unloadPlugin(String) - Method in class org.pf4j.AbstractPluginManager

Unload the specified plugin and it's dependents.

unloadPlugin(String) - Method in interface org.pf4j.PluginManager

Unload a plugin.

unresolvedPlugins - Variable in class org.pf4j.AbstractPluginManager

A list with unresolved plugins (unresolved dependency).

Unzip - Class in org.pf4j.util

This class extracts the content of the plugin zip into a directory.

Unzip() - Constructor for class org.pf4j.util.Unzip

Unzip(File, File) - Constructor for class org.pf4j.util.Unzip

V

validatePluginDescriptor(PluginDescriptor) - Method in class org.pf4j.AbstractPluginManager

Override this to change the validation criteria.

valueOf(String) - Static method in enum org.pf4j.PluginState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.pf4j.RuntimeMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.pf4j.PluginState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.pf4j.RuntimeMode

Returns an array containing the constants of this enum type, in the order they are declared.

versionManager - Variable in class org.pf4j.AbstractPluginManager

VersionManager - Interface in org.pf4j

Manager responsible for versions of plugins.

W

whichPlugin(Class<?>) - Method in class org.pf4j.AbstractPluginManager

whichPlugin(Class<?>) - Method in interface org.pf4j.PluginManager

Retrieves the PluginWrapper that loaded the given class 'clazz'.

wrapper - Variable in class org.pf4j.Plugin

Wrapper of the plugin.

write(Map<String, Set<String>>) - Method in class org.pf4j.processor.ExtensionStorage

write(Map<String, Set<String>>) - Method in class org.pf4j.processor.LegacyExtensionStorage

write(Map<String, Set<String>>) - Method in class org.pf4j.processor.ServiceProviderExtensionStorage

writeLines(Collection<String>, File) - Static method in class org.pf4j.util.FileUtils

Deprecated.

writeLines(Collection<String>, Path) - Static method in class org.pf4j.util.FileUtils

Z

ZipFileFilter - Class in org.pf4j.util

File filter that accepts all files ending with .ZIP.

ZipFileFilter() - Constructor for class org.pf4j.util.ZipFileFilter

ZipPluginManager - Class in org.pf4j

It's a PluginManager that loads each plugin from a zip file.

ZipPluginManager() - Constructor for class org.pf4j.ZipPluginManager

A B C D E F G H I J K L M N O P R S T U V W Z
All Classes All Packages