ch.jalu.configme.beanmapper.propertydescription

Class BeanPropertyComments

java.lang.Object

ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments

public class BeanPropertyComments
extends Object

Contains the comments for a bean property, with a UUID if the comment should only be included once.

Field Summary

Fields

Modifier and Type	Field and Description
static BeanPropertyComments	EMPTY Instance which can be used if there are no comments to add.

Constructor Summary

Constructors

Constructor and Description
BeanPropertyComments(@NotNull List<String> comments, @Nullable UUID uuid) Constructor.

Method Summary

Modifier and Type	Method and Description
@NotNull List<String>	getComments()
@Nullable UUID	getUuid() UUID to identify this comment.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final BeanPropertyComments EMPTY

Instance which can be used if there are no comments to add.

Constructor Detail

BeanPropertyComments

public BeanPropertyComments(@NotNull
                            @NotNull List<String> comments,
                            @Nullable
                            @Nullable UUID uuid)

Constructor.

Parameters:

comments - the comments

uuid - UUID to identify the comment with, null if the comment should be repeated

Method Detail

getComments

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

getUuid

@Nullable
public @Nullable UUID getUuid()

UUID to identify this comment. Not-null when the comment should not be repeated if it could be part of the export multiple times.

Returns:

UUID if the comment should be unique, null otherwise