Spring/spring-plugin
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

#40 - Fixed docs on general usage of PluginFactory API.

Browse Source
This commit is contained in:
Oliver Drotbohm
2019-03-04 16:14:10 +01:00
parent 4f05683a85
commit 5f6bf879d6
1 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.markdown
View File

@@ -47,7 +47,7 @@ public interface MyPluginInterface {
/**
* A host application class working with instances of the plugin
* A host application class working with instances of the plugin
* interface.
*/
public class HostImpl implements Host {
@@ -70,7 +70,7 @@ public class HostImpl implements Host {
}
```
This is the way you would typically construct a host component in general. Leveraging dependency injection via setters allows flexible usage in a variety of environments. Thus you could easily provide a factory class that is able to lookup `MyPluginInterface`
This is the way you would typically construct a host component in general. Leveraging dependency injection via setters allows flexible usage in a variety of environments. Thus you could easily provide a factory class that is able to lookup `MyPluginInterface`
implementations from the classpath, instantiate them and inject them into `HostImpl`.
Using Spring as component container you could configure something like this:
@@ -201,15 +201,14 @@ cases Spring Plugin provides a `PluginRegistry<T extends Plugin<S>, S>` interfac
**Example 1.7. Usage of the PluginRegistry**
```java
PluginRegistry<ProductProcessor, ProductType> registry = SimplePluginRegistry.create();
// Add plugin instances
registry.add(new FooImplementation());
// Returns the first plugin supporting SOFTWARE
registry.getPluginFor(ProductType.SOFTWARE);
PluginRegistry<ProductProcessor, ProductType> registry = SimplePluginRegistry.of(new FooImplementation());
// Returns the first plugin supporting SOFTWARE if available
Optional<ProductProcessor> plugin = registry.getPluginFor(ProductType.SOFTWARE);
// Returns the first plugin supporting SOFTWARE, or DefaultPlugin if none found
registry.getPluginFor(ProductType.SOFTWARE, new DefaultPlugin());
ProductProcessor plugin = registry.getPluginOrDefaultFor(ProductType.SOFTWARE, () -> new DefaultPlugin());
// Returns all plugins supporting HARDWARE, throwing the given exception if none found
registry.getPluginsFor(ProductType.HARDWARE, new MyException("Damn!");
List<ProductProcessor> plugin = registry.getPluginsFor(ProductType.HARDWARE, () -> new MyException("Damn!");
```
#### Configuration, XML namespace and @EnablePluginRegistries
@@ -276,15 +275,15 @@ The `MetadataProvider` interface is to be used in application plugin interfaces
### O
OSGi
* Open Services Gateway Initiative - a fully fledged plugin runtime environment on top of the Java VM - [http://en.wikipedia.org/wiki/OSGi](http://en.wikipedia.org/wiki/OSGi).
### X
XML
* eXtensible Markup Language
XSD
* Xml Schema Definition