com.palantir.javaformat.java

Class JavaCommentsHelper

java.lang.Object

com.palantir.javaformat.java.JavaCommentsHelper

All Implemented Interfaces:

CommentsHelper

public final class JavaCommentsHelper
extends java.lang.Object
implements CommentsHelper

JavaCommentsHelper extends CommentsHelper to rewrite Java comments.

Constructor Summary

Constructors

Constructor and Description
JavaCommentsHelper(java.lang.String lineSeparator, com.palantir.javaformat.java.JavaFormatterOptions options, com.palantir.javaformat.java.JavaFormatterInternalOptions internalOptions)

Method Summary

Modifier and Type	Method and Description
java.lang.String	rewrite(Input.Tok tok, int maxWidth, int column0) Try to rewrite comments, returning rewritten text.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaCommentsHelper

public JavaCommentsHelper(java.lang.String lineSeparator,
                          com.palantir.javaformat.java.JavaFormatterOptions options,
                          com.palantir.javaformat.java.JavaFormatterInternalOptions internalOptions)

Method Detail

rewrite

public java.lang.String rewrite(Input.Tok tok,
                                int maxWidth,
                                int column0)

Description copied from interface: CommentsHelper

Try to rewrite comments, returning rewritten text.

Specified by:

rewrite in interface CommentsHelper

Parameters:

tok - the comment's tok

maxWidth - the line length for the output

column0 - the current column

Returns:

the rewritten comment