Fix checkstyle warnings in yang-jmx-generator-plugin
[controller.git] / opendaylight / config / yang-jmx-generator-plugin / src / main / java / org / opendaylight / controller / config / yangjmxgenerator / plugin / util / StringUtil.java
1 package org.opendaylight.controller.config.yangjmxgenerator.plugin.util;
2
3 import com.google.common.base.Joiner;
4 import com.google.common.base.Optional;
5 import com.google.common.base.Splitter;
6 import com.google.common.base.Strings;
7 import java.util.List;
8 import java.util.regex.Pattern;
9 import org.apache.commons.lang3.StringUtils;
10 import org.opendaylight.controller.config.yangjmxgenerator.plugin.java.FullyQualifiedName;
11 import org.slf4j.Logger;
12 import org.slf4j.LoggerFactory;
13
14 public class StringUtil {
15     private static final Logger LOG = LoggerFactory.getLogger(StringUtil.class);
16
17     /**
18      * @param list   of strings to be joined by ','
19      * @param prefix e.g. 'extends' or 'implements'
20      */
21     public static String prefixAndJoin(List<FullyQualifiedName> list, String prefix) {
22         if (list.isEmpty()) {
23             return "";
24         }
25         Joiner joiner = Joiner.on(",");
26         return " " + prefix + " " + joiner.join(list);
27     }
28
29     public static String addAsterixAtEachLineStart(String input) {
30         String s = Pattern.compile("^", Pattern.MULTILINE).matcher(input).replaceAll("* ");
31         // remove trailing spaces
32         s = Pattern.compile("\\s+$", Pattern.MULTILINE).matcher(s).replaceAll("");
33         s = ensureEndsWithSingleNewLine(s);
34         return s;
35     }
36
37     private static String ensureEndsWithSingleNewLine(String s) {
38         // .split Only trailing empty strings are skipped.
39         String[] split = s.split("\n");
40         s = Joiner.on("\n").join(split);
41         s = s + "\n";
42         return s;
43     }
44
45     public static String writeComment(String input, boolean isJavadoc) {
46         StringBuilder content = new StringBuilder();
47         content.append("/*");
48         if (isJavadoc) {
49             content.append("*");
50         }
51         content.append("\n");
52
53         content.append(addAsterixAtEachLineStart(input));
54         content.append("*/\n");
55         return content.toString();
56     }
57
58
59     public static Optional<String> loadCopyright() {
60         /*
61          * FIXME: BUG-980: this is a nice feature, but the copyright needs to come
62          *        from the project being processed, not this one.
63             try (InputStream in = StringUtil.class.getResourceAsStream("/copyright.txt")) {
64                 if (in != null) {
65                     return Optional.of(IOUtils.toString(in));
66                 }
67             } catch (IOException e) {
68                 LOG.warn("Cannot load copyright.txt", e);
69             }
70
71         */
72         return Optional.absent();
73     }
74
75     public static String formatJavaSource(String input) {
76         Iterable<String> split = Splitter.on("\n").trimResults().split(input);
77
78         int basicIndent = 4;
79         StringBuilder sb = new StringBuilder();
80         int intends = 0, empty = 0;
81         for (String line : split) {
82             intends -= StringUtils.countMatches(line, "}");
83             if (intends < 0) {
84                 intends = 0;
85             }
86             if (line.isEmpty() == false) {
87                 sb.append(Strings.repeat(" ", basicIndent * intends));
88                 sb.append(line);
89                 sb.append("\n");
90                 empty = 0;
91             } else {
92                 empty++; // one empty line is allowed
93                 if (empty < 2) {
94                     sb.append("\n");
95                 }
96             }
97             intends += StringUtils.countMatches(line, "{");
98         }
99         return ensureEndsWithSingleNewLine(sb.toString());
100     }
101
102 }