Generated javadoc does not separate multi-line description
[mdsal.git] / binding / mdsal-binding-generator-util / src / main / java / org / opendaylight / mdsal / binding / model / util / FormattingUtils.java
1 /*
2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.mdsal.binding.model.util;
9
10 import com.google.common.annotations.Beta;
11 import com.google.common.base.CharMatcher;
12 import com.google.common.base.Strings;
13 import java.util.StringTokenizer;
14 import java.util.regex.Pattern;
15 import org.opendaylight.yangtools.yang.common.QName;
16
17 @Beta
18 public final class FormattingUtils {
19     private static final CharMatcher NEWLINE_OR_TAB = CharMatcher.anyOf("\n\t");
20     private static final Pattern MULTIPLE_SPACES_PATTERN = Pattern.compile(" +");
21
22     private FormattingUtils() {
23         throw new UnsupportedOperationException();
24     }
25
26     public static String formatToAugmentPath(final Iterable<QName> schemaPath) {
27         final StringBuilder sb = new StringBuilder();
28         for (QName pathElement : schemaPath) {
29             sb.append("\\(").append(pathElement.getNamespace()).append(')').append(pathElement.getLocalName());
30         }
31         return sb.toString();
32     }
33
34     public static String formatToParagraph(final String text, final int nextLineIndent) {
35         if (Strings.isNullOrEmpty(text)) {
36             return "";
37         }
38
39         final StringBuilder sb = new StringBuilder();
40         final StringBuilder lineBuilder = new StringBuilder();
41         final String lineIndent = Strings.repeat(" ", nextLineIndent);
42         final String formattedText = MULTIPLE_SPACES_PATTERN.matcher(NEWLINE_OR_TAB.replaceFrom(text, " "))
43                 .replaceAll(" ");
44         final StringTokenizer tokenizer = new StringTokenizer(formattedText, " ", true);
45
46         boolean isFirstElementOnNewLineEmptyChar = false;
47         while (tokenizer.hasMoreElements()) {
48             final String nextElement = tokenizer.nextElement().toString();
49
50             if (lineBuilder.length() + nextElement.length() > 80) {
51                 // Trim trailing whitespace
52                 for (int i = lineBuilder.length() - 1; i >= 0 && lineBuilder.charAt(i) != ' '; --i) {
53                     lineBuilder.setLength(i);
54                 }
55
56                 // Trim leading whitespace
57                 while (lineBuilder.length() > 0 && lineBuilder.charAt(0) == ' ') {
58                     lineBuilder.deleteCharAt(0);
59                 }
60
61                 sb.append(lineBuilder).append('\n');
62                 lineBuilder.setLength(0);
63
64                 if (nextLineIndent > 0) {
65                     sb.append(lineIndent);
66                 }
67
68                 if (" ".equals(nextElement)) {
69                     isFirstElementOnNewLineEmptyChar = true;
70                 }
71             }
72             if (isFirstElementOnNewLineEmptyChar) {
73                 isFirstElementOnNewLineEmptyChar = false;
74             } else {
75                 lineBuilder.append(nextElement);
76             }
77         }
78
79         return sb.append(lineBuilder).append('\n').toString();
80     }
81 }