diff options
Diffstat (limited to 'src/main/java/sevenUnits/utils/NameSymbol.java')
-rw-r--r-- | src/main/java/sevenUnits/utils/NameSymbol.java | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/main/java/sevenUnits/utils/NameSymbol.java b/src/main/java/sevenUnits/utils/NameSymbol.java index 290dcd6..a91009e 100644 --- a/src/main/java/sevenUnits/utils/NameSymbol.java +++ b/src/main/java/sevenUnits/utils/NameSymbol.java @@ -31,6 +31,7 @@ import java.util.Set; * @since 2019-10-21 */ public final class NameSymbol { + /** The {@code NameSymbol} with all fields empty. */ public static final NameSymbol EMPTY = new NameSymbol(Optional.empty(), Optional.empty(), new HashSet<>()); @@ -297,6 +298,9 @@ public final class NameSymbol { * Creates and returns a copy of this {@code NameSymbol} with the provided * extra name. If this {@code NameSymbol} has a primary name, the provided * name will become an other name, otherwise it will become the primary name. + * + * @param name additional name to add + * @return copy of this NameSymbol with the additional name * * @since v0.4.0 * @since 2022-04-19 |