Browse Source

Add javadoc

pull/349/head
Decebal Suiu 5 years ago
parent
commit
e6093a313b
  1. 6
      pf4j/src/main/java/org/pf4j/processor/ExtensionAnnotationProcessor.java
  2. 4
      pf4j/src/main/java/org/pf4j/processor/ExtensionStorage.java
  3. 2
      pf4j/src/main/java/org/pf4j/processor/LegacyExtensionStorage.java
  4. 2
      pf4j/src/main/java/org/pf4j/processor/ServiceProviderExtensionStorage.java

6
pf4j/src/main/java/org/pf4j/processor/ExtensionAnnotationProcessor.java

@ -40,6 +40,11 @@ import java.util.Set;
import java.util.TreeSet;
/**
* Processes {@link Extension} annotations and generates an {@link ExtensionStorage}.
* You can specify the concrete {@link ExtensionStorage} via processor's environment options
* ({@link ProcessingEnvironment#getOptions()}) or system property.
* In both variants the option/property name is {@code pf4j.storageClassName}.
*
* @author Decebal Suiu
*/
public class ExtensionAnnotationProcessor extends AbstractProcessor {
@ -241,4 +246,5 @@ public class ExtensionAnnotationProcessor extends AbstractProcessor {
return storage;
}
}

4
pf4j/src/main/java/org/pf4j/processor/ExtensionStorage.java

@ -21,6 +21,10 @@ import java.util.Map;
import java.util.Set;
/**
* It's a storage (database) that persists {@link org.pf4j.Extension}s.
* The standard operations supported by storage are {@link #read} and {@link #write}.
* The storage is populated by {@link ExtensionAnnotationProcessor}.
*
* @author Decebal Suiu
*/
public abstract class ExtensionStorage {

2
pf4j/src/main/java/org/pf4j/processor/LegacyExtensionStorage.java

@ -31,6 +31,8 @@ import java.util.Set;
import java.util.regex.Pattern;
/**
* Stores {@link org.pf4j.Extension}s in {@code META-INF/extensions.idx}.
*
* @author Decebal Suiu
*/
public class LegacyExtensionStorage extends ExtensionStorage {

2
pf4j/src/main/java/org/pf4j/processor/ServiceProviderExtensionStorage.java

@ -31,6 +31,8 @@ import java.util.Set;
import java.util.regex.Pattern;
/**
* Stores {@link org.pf4j.Extension}s in {@code META-INF/services}.
*
* @author Decebal Suiu
*/
public class ServiceProviderExtensionStorage extends ExtensionStorage {

Loading…
Cancel
Save