diff options
| author | Nicholas DiPiazza <nicholas.dipiazza@lucidworks.com> | 2017-08-11 14:57:58 -0500 |
|---|---|---|
| committer | Decebal Suiu <decebal.suiu@gmail.com> | 2017-08-11 22:57:58 +0300 |
| commit | a569bb576879fe64b99ff2c17bc8162ba99bb4d5 (patch) | |
| tree | afedea742cda6b397d69516293b882dcf7a3383c | |
| parent | e77cd9106880f38992421dce7b00175e4ecd8e35 (diff) | |
| download | pf4j-a569bb576879fe64b99ff2c17bc8162ba99bb4d5.tar.gz pf4j-a569bb576879fe64b99ff2c17bc8162ba99bb4d5.zip | |
add some javadoc so people don't wonder if this will throw exception or return null. (#160)
| -rw-r--r-- | pf4j/src/main/java/ro/fortsoft/pf4j/PluginManager.java | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/pf4j/src/main/java/ro/fortsoft/pf4j/PluginManager.java b/pf4j/src/main/java/ro/fortsoft/pf4j/PluginManager.java index 2efd9f3..793784b 100644 --- a/pf4j/src/main/java/ro/fortsoft/pf4j/PluginManager.java +++ b/pf4j/src/main/java/ro/fortsoft/pf4j/PluginManager.java @@ -53,10 +53,10 @@ public interface PluginManager { List<PluginWrapper> getStartedPlugins(); /** - * Retrieves the plugin with this id. + * Retrieves the plugin with this id, or null if the plugin does not exist. * - * @param pluginId - * @return the plugin + * @param pluginId The pluginId for the plugin you are trying to get. + * @return A PluginWrapper object for this plugin, or null if it does not exist. */ PluginWrapper getPlugin(String pluginId); |