BasePluginRepository

java.lang.Object

org.pf4j.BasePluginRepository

All Implemented Interfaces:: PluginRepository

Direct Known Subclasses:: DefaultPluginRepository, DevelopmentPluginRepository, JarPluginRepository

public class BasePluginRepository extends Object implements PluginRepository

Field Summary

Fields

Modifier and Type

Field

Description

protected Comparator<File>

comparator

protected FileFilter

filter

protected final Path

pluginsRoot
Constructor Summary

Constructors

Constructor

Description

BasePluginRepository(Path pluginsRoot)

BasePluginRepository(Path pluginsRoot, FileFilter filter)
Method Summary

Modifier and Type

Method

Description

boolean

deletePluginPath(Path pluginPath)

Removes a plugin from the repository.

List<Path>

getPluginPaths()

List all plugin paths.

void

setComparator(Comparator<File> comparator)

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

void

setFilter(FileFilter filter)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- pluginsRoot
  
  protected final Path pluginsRoot
- filter
  
  protected FileFilter filter
- comparator
  
  protected Comparator<File> comparator
Constructor Details
- BasePluginRepository
  
  public BasePluginRepository(Path pluginsRoot)
- BasePluginRepository
  
  public BasePluginRepository(Path pluginsRoot, FileFilter filter)
Method Details
- setFilter
  
  public void setFilter(FileFilter filter)
- setComparator
  
  public void setComparator(Comparator<File> comparator)
  
  Set a File Comparator used to sort the listed files from pluginsRoot. This comparator is used in getPluginPaths() method. By default is used a file comparator that returns the last modified files first. If you don't want a file comparator, then call this method with null.
- getPluginPaths
  
  public List<Path> getPluginPaths()
  
  Description copied from interface: PluginRepository
  
  List all plugin paths.
  
  Specified by:
  
  getPluginPaths in interface PluginRepository
  
  Returns:
  
  a list with paths
- deletePluginPath
  
  public boolean deletePluginPath(Path pluginPath)
  
  Description copied from interface: PluginRepository
  
  Removes a plugin from the repository.
  
  Specified by:
  
  deletePluginPath in interface PluginRepository
  
  Parameters:
  
  pluginPath - the plugin path
  
  Returns:
  
  true if deleted