diff options
Diffstat (limited to 'base/src/main/java/bjc/utils/funcutils/IBuilder.java')
| -rw-r--r-- | base/src/main/java/bjc/utils/funcutils/IBuilder.java | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/base/src/main/java/bjc/utils/funcutils/IBuilder.java b/base/src/main/java/bjc/utils/funcutils/IBuilder.java index a96a4d6..6cbb838 100644 --- a/base/src/main/java/bjc/utils/funcutils/IBuilder.java +++ b/base/src/main/java/bjc/utils/funcutils/IBuilder.java @@ -1,29 +1,31 @@ package bjc.utils.funcutils; /** - * Generic interface for objects that implement the builder pattern + * Generic interface for objects that implement the builder pattern. * * @author ben * * @param <E> - * The type of object being built + * The type of object being built. */ public interface IBuilder<E> { /** - * Build the object this builder is building + * Build the object this builder is building. + * + * @return + * The built object. * - * @return The built object * @throws IllegalStateException - * if the data in the builder cannot be built into its - * corresponding object at this point in time + * If the data in the builder cannot be built into its + * corresponding object at this point in time. */ public E build(); /** - * Reset the state of this builder to its initial state + * Reset the state of this builder to its initial state. * * @throws UnsupportedOperationException - * if the builder doesn't support resetting its state + * If the builder doesn't support resetting its state. */ public default void reset() { throw new UnsupportedOperationException("Builder doesn't support state resetting"); |