com.palantir.javaformat.CommentsHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of palantir-java-format Show documentation

Palantir open source project

There is a newer version: 2.50.0

/*
 * Copyright 2015 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.palantir.javaformat;

/**
 * Rewrite comments. This interface is implemented by {@link com.palantir.javaformat.java.JavaCommentsHelper
 * JavaCommentsHelper}.
 */
public interface CommentsHelper {
    /**
     * Try to rewrite comments, returning rewritten text.
     *
     * @param tok the comment's tok
     * @param maxWidth the line length for the output
     * @param column0 the current column
     * @return the rewritten comment
     */
    String rewrite(Input.Tok tok, int maxWidth, int column0);
}