ch.jalu.configme.properties.convertresult

Class ValueWithComments

java.lang.Object

ch.jalu.configme.properties.convertresult.ValueWithComments

public class ValueWithComments
extends Object

Wraps a value and allows to associate it with comments. Can be used as return type from Property.toExportValue(T).

Prefer defining comments in SettingsHolder classes whenever your comments can be statically defined.

Constructor Summary

Constructors

Constructor and Description
ValueWithComments(@NotNull Object value, @NotNull List<String> comments) Constructor.
ValueWithComments(@NotNull Object value, @NotNull List<String> comments, @Nullable UUID uniqueCommentId) Constructor.

Method Summary

Modifier and Type	Method and Description
@NotNull List<String>	getComments()
@Nullable UUID	getUniqueCommentId()
@NotNull Object	getValue()
static @NotNull Stream<String>	streamThroughCommentsIfApplicable(@Nullable Object object, @Nullable Set<UUID> usedCommentIds) Returns a stream with the comments on the given object, if it is a ValueWithComments and its comments aren't specified to be unique, or if the comments are encountered for the first time.
static @NotNull Object	unwrapValue(@NotNull Object object) Unwraps the value and returns the actual value contained in this wrapper if the object is an instance of this class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueWithComments

public ValueWithComments(@NotNull
                         @NotNull Object value,
                         @NotNull
                         @NotNull List<String> comments,
                         @Nullable
                         @Nullable UUID uniqueCommentId)

Constructor.

The UUID is associated with the comments and should be not null if the comments should only appear once. Use a random UUID if the comments might appear multiple times, e.g. because they were defined on a type that a property uses in a collection. If repetition is desired, or if you're creating an object in simple cases where the comment cannot be repeated, you can use the constructor ValueWithComments(Object, List).

Parameters:

value - the value to wrap

comments - the comments associated with the value

uniqueCommentId - UUID to identify the comment by, if it should not be repeated (null otherwise)

ValueWithComments

public ValueWithComments(@NotNull
                         @NotNull Object value,
                         @NotNull
                         @NotNull List<String> comments)

Constructor.

Parameters:

value - the value to wrap

comments - the comments associated with the value

Method Detail

getValue

@NotNull
public @NotNull Object getValue()

Returns:

the value wrapped by this instance

getComments

@NotNull
public @NotNull List<String> getComments()

Returns:

the comments associated with the value

getUniqueCommentId

@Nullable
public @Nullable UUID getUniqueCommentId()

Returns:

UUID to identify the comments, if the comments should only be included the first time they're encountered

unwrapValue

@NotNull
public static @NotNull Object unwrapValue(@NotNull
                                                   @NotNull Object object)

Unwraps the value and returns the actual value contained in this wrapper if the object is an instance of this class. Otherwise, the same value as the parameter is returned.

Parameters:

object - the object to potentially unwrap

Returns:

the value of ValueWithComments if the object is of this type, otherwise the object itself

streamThroughCommentsIfApplicable

@NotNull
public static @NotNull Stream<String> streamThroughCommentsIfApplicable(@Nullable
                                                                                 @Nullable Object object,
                                                                                 @Nullable
                                                                                 @Nullable Set<UUID> usedCommentIds)

Returns a stream with the comments on the given object, if it is a ValueWithComments and its comments aren't specified to be unique, or if the comments are encountered for the first time. An empty stream is returned if the object is not an instance of this class, or if the comments are defined to be unique and were already encountered (as determined by the set of used comment IDs).

Parameters:

object - the object to get comments from, if applicable

usedCommentIds - UUIDs of comments which should not be repeated that have already been included

Returns:

stream with the comments (never null)