summaryrefslogtreecommitdiff
path: root/src/org/unitConverter/math/ObjectProduct.java
diff options
context:
space:
mode:
authorAdrien Hopkins <masterofnumbers17@gmail.com>2019-11-26 15:20:04 -0500
committerAdrien Hopkins <masterofnumbers17@gmail.com>2019-11-26 15:20:04 -0500
commita966676c629f7f14fcbba82a9ada5e2cbeca8314 (patch)
tree63e93526528f963d99570230a4b72830400840bc /src/org/unitConverter/math/ObjectProduct.java
parent7bf4824a0619a79cb10faf8f83146b96e51341d2 (diff)
Updated the documentation of existing classes.
Diffstat (limited to 'src/org/unitConverter/math/ObjectProduct.java')
-rw-r--r--src/org/unitConverter/math/ObjectProduct.java8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/org/unitConverter/math/ObjectProduct.java b/src/org/unitConverter/math/ObjectProduct.java
index 0cf89ec..29d0f6e 100644
--- a/src/org/unitConverter/math/ObjectProduct.java
+++ b/src/org/unitConverter/math/ObjectProduct.java
@@ -238,6 +238,14 @@ public final class ObjectProduct<T> {
return new ObjectProduct<>(map);
}
+ /**
+ * Converts this product to a string using the objects' {@link Object#toString()} method. If objects have a long
+ * toString representation, it is recommended to use {@link #toString(Function)} instead to shorten the returned
+ * string.
+ *
+ * <p>
+ * {@inheritDoc}
+ */
@Override
public String toString() {
return this.toString(Object::toString);