Package net.darkhax.pricklemc.common.api.config.comment

Class WrappedComment.WrappedCommentResolver

java.lang.Object

net.darkhax.pricklemc.common.api.config.comment.WrappedComment.WrappedCommentResolver

All Implemented Interfaces:

ICommentResolver

Enclosing class:

WrappedComment

public static class WrappedComment.WrappedCommentResolver
extends Object
implements ICommentResolver

Resolves comments by wrapping the text to the specified width and optionally padding multi-line comments to the maximum line length.

Constructor Summary

Constructors

Constructor	Description
WrappedCommentResolver(int lineLength, boolean padLength)

Method Summary

Modifier and Type	Method	Description
@Nullable WrappedComment	resolve(Field field, @Nullable Object value, Value valueMeta)	Attempts to resolve a comment for a config property using the available information.

Methods inherited from class java.lang.Object

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

Constructor Details

WrappedCommentResolver

public WrappedCommentResolver(int lineLength,
 boolean padLength)

Method Details

resolve

@Nullable
public @Nullable WrappedComment resolve(Field field,
 @Nullable
 @Nullable Object value,
 Value valueMeta)
                                 throws IOException

Description copied from interface: ICommentResolver

Attempts to resolve a comment for a config property using the available information.

Specified by:

resolve in interface ICommentResolver

Parameters:

field - The field being mapped.

value - The value of the field.

valueMeta - The value annotation metadata.

Returns:

The comment that was resolved. Null may be returned when the comment could not be resolved.

Throws:

IOException - An exception may be thrown if fatal errors are encountered while resolving the comment.