Clarify that toString(), equals() and hashCode() all delegate to value

2017-12-09 17:38:04 +00:00 · 2017-12-09 17:38:04 +00:00 · ba4380fe98
commit ba4380fe98
parent 27019b23c1
1 changed files with 3 additions and 0 deletions
--- a/src/main/java/net/kemitix/mon/TypeAlias.java
+++ b/src/main/java/net/kemitix/mon/TypeAlias.java
@ -26,6 +26,9 @@ import java.util.function.Function;
 /**
 * Type Alias for other types.
 *
+ * <p>{@link #toString()}, {@link #equals(Object)} and {@link #hashCode()} are all transparent, returning the value
+ * for the type being aliased.</p>
+ *
 * @param <T> the type of the alias
 *
 * @author Paul Campbell (pcampbell@kemitix.net)