Record Class Comment

java.lang.Object

java.lang.Record

net.tangly.core.Comment

Record Components:

created - timestamp when the comment was created

author - of the comment instance as human-readable field

text - text of the comment, we recommend using asciidoc format

tags - set of tags associated with the comment

All Implemented Interfaces:

HasTags

public record Comment(LocalDateTime created, String author, String text, Set<Tag> tags)
extends Record
implements HasTags

Defines a human-readable annotation to an entity. A comment is an immutable object. Comments can be tagged to provide classification. A comment belongs to the entity owning it an is only accessible through this entity.

Field Summary

Fields inherited from interface net.tangly.core.HasTags

TAGS

Constructor Summary

Constructors

Constructor	Description
Comment(@NotNull LocalDateTime created, @NotNull String author, @NotNull String text)	Default constructor to create an immutable instance.
Comment(LocalDateTime created, String author, String text, Set<Tag> tags)	Creates an instance of a Comment record class.

Method Summary

Modifier and Type	Method	Description
String	author()	Returns the value of the author record component.
LocalDateTime	created()	Returns the value of the created record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static Comment	of(@NotNull String author, @NotNull String text)
Set<Tag>	tags()	Returns the value of the tags record component.
String	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.tangly.core.HasTags

containsTag, containsTag, findBy, findBy, findByNamespace, rawTags, value, value

Constructor Details

Comment

public Comment(@NotNull
 @NotNull LocalDateTime created,
 @NotNull
 @NotNull String author,
 @NotNull
 @NotNull String text)

Default constructor to create an immutable instance.

Parameters:

created - timestamp when the comment was created

author - of the comment instance as human-readable field

text - text of the comment, we recommend using asciidoc format

Comment

public Comment(LocalDateTime created,
 String author,
 String text,
 Set<Tag> tags)

Creates an instance of a Comment record class.

Parameters:

created - the value for the created record component

author - the value for the author record component

text - the value for the text record component

tags - the value for the tags record component

Method Details

of

public static Comment of(@NotNull
 @NotNull String author,
 @NotNull
 @NotNull String text)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

created

public LocalDateTime created()

Returns the value of the created record component.

Returns:

the value of the created record component

author

public String author()

Returns the value of the author record component.

Returns:

the value of the author record component

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

tags

public Set<Tag> tags()

Returns the value of the tags record component.

Specified by:

tags in interface HasTags

Returns:

the value of the tags record component