Package dev.siroshun.configapi.core.comment

Interface SimpleComment

All Superinterfaces:

Comment

All Known Implementing Classes:

YamlBlockComment, YamlInlineComment

@NotNullByDefault
public interface SimpleComment
extends Comment

An interface that has the comment as a String.

Method Summary

Modifier and Type	Method	Description
String	content()	Gets the content.
static SimpleComment	create(String content)	Creates a new SimpleComment.
static SimpleComment	create(String content, String type)	Creates a new SimpleComment.
String	type()	Returns the type of this comment.

Method Details

create

@Contract("_ -> new")
static SimpleComment create(String content)

Creates a new SimpleComment.

Parameters:

content - the content

Returns:

a new SimpleComment

create

@Contract("_, _ -> new")
static SimpleComment create(String content,
 String type)

Creates a new SimpleComment.

Parameters:

content - the content

type - the type of the comment

Returns:

a new SimpleComment

content

String content()

Gets the content.

Returns:

the content

type

String type()

Returns the type of this comment.

Returns:

the type of this comment