capital.scalable.restdocs.javadoc.JavadocUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-auto-restdocs-core Show documentation
Spring Auto REST Docs is an extension to Spring REST Docs
The newest version!
/*-
 * #%L
 * Spring Auto REST Docs Core
 * %%
 * Copyright (C) 2015 - 2021 Scalable Capital GmbH
 * %%
 * 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.
 * #L%
 */
package capital.scalable.restdocs.javadoc;

import capital.scalable.restdocs.util.TemplateFormatting;

public class JavadocUtil {
    private static String FORCED_LB = "__FLB__";
    private static String LB = "__LB__";

    private JavadocUtil() {
        // util
    }

    public static String convertFromJavadoc(String javadoc, TemplateFormatting templateFormatting) {
        String converted = javadoc
                // line breaks in javadoc are ignored
                .replace("\n", "")
                // will be replaced with forced line break
                .replace("
", FORCED_LB)
                .replace("
", FORCED_LB)
                // will be replaced with normal line break
                .replace("", LB + LB)
                .replace("", LB + LB)
                .replace("", LB)
                .replace("", LB + LB)
                .replace("", LB + "- ")
                .replace("", "")
                .replace("", templateFormatting.getBold())
                .replace("", templateFormatting.getBold())
                .replace("", templateFormatting.getBold())
                .replace("", templateFormatting.getBold())
                .replace("", templateFormatting.getItalics())
                .replace("", templateFormatting.getItalics())
                .replace("", templateFormatting.getItalics())
                .replace("", templateFormatting.getItalics())
                .replace("", templateFormatting.getCode())
                .replace("", templateFormatting.getCode())
                .replaceAll("(.*?)",
                        templateFormatting.link());

        if (converted.isEmpty()) {
            return "";
        }

        String res = trimAndFixLineBreak(converted, FORCED_LB, templateFormatting.getLineBreak());
        res = trimAndFixLineBreak(res, LB, "\n");
        return res;
    }

    private static String trimAndFixLineBreak(String text, String separator, String newSeparator) {
        StringBuilder res = new StringBuilder();
        for (String line : text.split(separator)) {
            res.append(line.trim()).append(newSeparator);
        }
        res.delete(res.lastIndexOf(newSeparator), res.length());
        return res.toString();
    }
}