summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/data/Identity.java
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 13:41:07 -0300
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 13:41:07 -0300
commit946cab444bc301d8a7c756a1bab039558288de89 (patch)
tree419f27c39a509bcd83cae0e6630be8eb7ff95a30 /base/src/main/java/bjc/utils/data/Identity.java
parentc82e3b3b2de0633317ec8fc85925e91422820597 (diff)
Cleanup work
Diffstat (limited to 'base/src/main/java/bjc/utils/data/Identity.java')
-rw-r--r--base/src/main/java/bjc/utils/data/Identity.java28
1 files changed, 12 insertions, 16 deletions
diff --git a/base/src/main/java/bjc/utils/data/Identity.java b/base/src/main/java/bjc/utils/data/Identity.java
index a8c8d70..3acb5aa 100644
--- a/base/src/main/java/bjc/utils/data/Identity.java
+++ b/base/src/main/java/bjc/utils/data/Identity.java
@@ -4,33 +4,27 @@ import java.util.function.Function;
import java.util.function.UnaryOperator;
/**
- * @author ben
- *
- * @param <ContainedType>
- */
-/**
- * Simple implementation of IHolder that has no hidden behavior
+ * Simple implementation of IHolder that has no hidden behavior.
*
* @author ben
*
* @param <ContainedType>
- * The type contained in the holder
+ * The type contained in the holder.
*/
public class Identity<ContainedType> implements IHolder<ContainedType> {
+ /* The held value. */
private ContainedType heldValue;
- /**
- * Create a holder holding null
- */
+ /** Create a holder holding null */
public Identity() {
heldValue = null;
}
/**
- * Create a holder holding the specified value
+ * Create a holder holding the specified value.
*
* @param value
- * The value to hold
+ * The value to hold.
*/
public Identity(final ContainedType value) {
heldValue = value;
@@ -99,9 +93,10 @@ public class Identity<ContainedType> implements IHolder<ContainedType> {
* Create a new identity container.
*
* @param val
- * The contained value.
+ * The contained value.
*
- * @return A new identity container.
+ * @return
+ * A new identity container.
*/
public static <ContainedType> Identity<ContainedType> id(final ContainedType val) {
return new Identity<>(val);
@@ -110,9 +105,10 @@ public class Identity<ContainedType> implements IHolder<ContainedType> {
/**
* Create a new empty identity container.
*
- * @return A new empty identity container.
+ * @return
+ * A new empty identity container.
*/
public static <ContainedType> Identity<ContainedType> id() {
return new Identity<>();
}
-} \ No newline at end of file
+}