From 539c5e5191ef363aee2479b87fc61f2bf9f45d41 Mon Sep 17 00:00:00 2001 From: Robert Winkler Date: Fri, 1 Apr 2016 09:29:03 +0200 Subject: [PATCH] Fixed JavaDoc Removed commons-collection by using Java8 Streams --- build.gradle | 3 +- gradle/wrapper/gradle-wrapper.properties | 4 +-- .../markup/builder/MarkupDocBuilder.java | 6 ++-- .../markup/builder/MarkupTableColumn.java | 3 +- .../internal/AbstractMarkupDocBuilder.java | 1 + .../internal/asciidoc/AsciiDocBuilder.java | 19 +++--------- .../ConfluenceMarkupBuilder.java | 21 ++++++------- .../internal/markdown/MarkdownBuilder.java | 31 +++++++------------ 8 files changed, 36 insertions(+), 52 deletions(-) diff --git a/build.gradle b/build.gradle index f3ecc3d2..46d73841 100644 --- a/build.gradle +++ b/build.gradle @@ -26,6 +26,7 @@ tasks.withType(JavaCompile) { options.deprecation = true options.encoding = 'UTF-8' options.compilerArgs << "-Xlint:unchecked" + options.compilerArgs << "-Xdoclint:none" } repositories { @@ -35,7 +36,7 @@ repositories { dependencies { compile 'org.slf4j:slf4j-api:1.7.18' - compile 'org.apache.commons:commons-collections4:4.1' + //compile 'org.apache.commons:commons-collections4:4.1' compile 'org.apache.commons:commons-lang3:3.4' compile "commons-io:commons-io:2.4" compile "commons-codec:commons-codec:1.10" diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index b122144a..69c2efe6 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ -#Thu Mar 31 16:26:24 CEST 2016 +#Thu Mar 31 16:37:14 CEST 2016 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-all.zip diff --git a/src/main/java/io/github/swagger2markup/markup/builder/MarkupDocBuilder.java b/src/main/java/io/github/swagger2markup/markup/builder/MarkupDocBuilder.java index 37b6db86..56319216 100644 --- a/src/main/java/io/github/swagger2markup/markup/builder/MarkupDocBuilder.java +++ b/src/main/java/io/github/swagger2markup/markup/builder/MarkupDocBuilder.java @@ -487,9 +487,9 @@ public interface MarkupDocBuilder { * Import some markup text into this builder.
* If {@code markupLanguage} is different from current builder language, markupText is converted when supported, or conversion is just ignored.
* Currently supported conversions : - *
  • - * - *
    • + * * Newlines are normalized in the process. * * @param markupText markup reader to read data from diff --git a/src/main/java/io/github/swagger2markup/markup/builder/MarkupTableColumn.java b/src/main/java/io/github/swagger2markup/markup/builder/MarkupTableColumn.java index 401a62bc..d95c5d64 100644 --- a/src/main/java/io/github/swagger2markup/markup/builder/MarkupTableColumn.java +++ b/src/main/java/io/github/swagger2markup/markup/builder/MarkupTableColumn.java @@ -27,7 +27,8 @@ public class MarkupTableColumn { /** * Header and specifiers constructor. * - * @param header header name + * @param header header + * @param headerColumn set column as an header column. * @param widthRatio width ratio */ public MarkupTableColumn(String header, boolean headerColumn, Integer widthRatio) { diff --git a/src/main/java/io/github/swagger2markup/markup/builder/internal/AbstractMarkupDocBuilder.java b/src/main/java/io/github/swagger2markup/markup/builder/internal/AbstractMarkupDocBuilder.java index 2a14dd69..9de13542 100644 --- a/src/main/java/io/github/swagger2markup/markup/builder/internal/AbstractMarkupDocBuilder.java +++ b/src/main/java/io/github/swagger2markup/markup/builder/internal/AbstractMarkupDocBuilder.java @@ -455,6 +455,7 @@ public abstract class AbstractMarkupDocBuilder implements MarkupDocBuilder { @Override public MarkupDocBuilder table(List> cells) { + Validate.notEmpty(cells, "cells must not be null"); return tableWithColumnSpecs(null, cells); } diff --git a/src/main/java/io/github/swagger2markup/markup/builder/internal/asciidoc/AsciiDocBuilder.java b/src/main/java/io/github/swagger2markup/markup/builder/internal/asciidoc/AsciiDocBuilder.java index 26aa7716..a9a6601e 100644 --- a/src/main/java/io/github/swagger2markup/markup/builder/internal/asciidoc/AsciiDocBuilder.java +++ b/src/main/java/io/github/swagger2markup/markup/builder/internal/asciidoc/AsciiDocBuilder.java @@ -21,14 +21,13 @@ package io.github.swagger2markup.markup.builder.internal.asciidoc; import io.github.swagger2markup.markup.builder.*; import io.github.swagger2markup.markup.builder.internal.AbstractMarkupDocBuilder; import io.github.swagger2markup.markup.builder.internal.Markup; -import org.apache.commons.collections4.CollectionUtils; -import org.apache.commons.collections4.Transformer; import org.apache.commons.lang3.Validate; import java.io.File; import java.io.Reader; import java.util.*; import java.util.regex.Pattern; +import java.util.stream.Collectors; import static org.apache.commons.lang3.StringUtils.*; @@ -190,11 +189,11 @@ public class AsciiDocBuilder extends AbstractMarkupDocBuilder { @Override public MarkupDocBuilder tableWithColumnSpecs(List columnSpecs, List> cells) { - + Validate.notEmpty(cells, "cells must not be null"); Boolean hasHeader = false; List options = new ArrayList<>(); List cols = new ArrayList<>(); - if (CollectionUtils.isNotEmpty(columnSpecs)) { + if (columnSpecs != null && !columnSpecs.isEmpty()) { for (MarkupTableColumn col : columnSpecs) { if (!hasHeader && isNotBlank(col.header)) { options.add("header"); @@ -213,20 +212,12 @@ public class AsciiDocBuilder extends AbstractMarkupDocBuilder { documentBuilder.append("[options=\"").append(join(options, ",")).append("\", cols=\"").append(join(cols, ",")).append("\"]").append(newLine); documentBuilder.append(AsciiDoc.TABLE).append(newLine); if (hasHeader) { - Collection headerList = CollectionUtils.collect(columnSpecs, new Transformer() { - public String transform(final MarkupTableColumn header) { - return formatTableCell(defaultString(header.header)); - } - }); + Collection headerList = columnSpecs.stream().map(header -> formatTableCell(defaultString(header.header))).collect(Collectors.toList()); documentBuilder.append(AsciiDoc.TABLE_COLUMN_DELIMITER).append(join(headerList, AsciiDoc.TABLE_COLUMN_DELIMITER.toString())).append(newLine); } for (List row : cells) { - Collection cellList = CollectionUtils.collect(row, new Transformer() { - public String transform(final String cell) { - return formatTableCell(defaultString(cell)); - } - }); + Collection cellList = row.stream().map(cell -> formatTableCell(defaultString(cell))).collect(Collectors.toList()); documentBuilder.append(AsciiDoc.TABLE_COLUMN_DELIMITER).append(join(cellList, AsciiDoc.TABLE_COLUMN_DELIMITER.toString())).append(newLine); } documentBuilder.append(AsciiDoc.TABLE).append(newLine); diff --git a/src/main/java/io/github/swagger2markup/markup/builder/internal/confluenceMarkup/ConfluenceMarkupBuilder.java b/src/main/java/io/github/swagger2markup/markup/builder/internal/confluenceMarkup/ConfluenceMarkupBuilder.java index 34b4009f..9407e948 100644 --- a/src/main/java/io/github/swagger2markup/markup/builder/internal/confluenceMarkup/ConfluenceMarkupBuilder.java +++ b/src/main/java/io/github/swagger2markup/markup/builder/internal/confluenceMarkup/ConfluenceMarkupBuilder.java @@ -224,6 +224,7 @@ public final class ConfluenceMarkupBuilder extends AbstractMarkupDocBuilder { @Override public MarkupDocBuilder tableWithColumnSpecs(List columnSpecs, List> cells) { + Validate.notEmpty(cells, "cells must not be null"); documentBuilder.append(newLine); if (columnSpecs != null && !columnSpecs.isEmpty()) { documentBuilder.append("||"); @@ -232,19 +233,17 @@ public final class ConfluenceMarkupBuilder extends AbstractMarkupDocBuilder { } documentBuilder.append(newLine); } - if (cells != null) { - for (List row : cells) { - documentBuilder.append(ConfluenceMarkup.TABLE_COLUMN_DELIMITER); - ListIterator cellIterator = row.listIterator(); - while (cellIterator.hasNext()) { - int cellIndex = cellIterator.nextIndex(); - if (columnSpecs != null && columnSpecs.size() > cellIndex && columnSpecs.get(cellIndex).headerColumn) - documentBuilder.append(ConfluenceMarkup.TABLE_COLUMN_DELIMITER); + for (List row : cells) { + documentBuilder.append(ConfluenceMarkup.TABLE_COLUMN_DELIMITER); + ListIterator cellIterator = row.listIterator(); + while (cellIterator.hasNext()) { + int cellIndex = cellIterator.nextIndex(); + if (columnSpecs != null && columnSpecs.size() > cellIndex && columnSpecs.get(cellIndex).headerColumn) + documentBuilder.append(ConfluenceMarkup.TABLE_COLUMN_DELIMITER); - documentBuilder.append(formatCellContent(cellIterator.next())).append(ConfluenceMarkup.TABLE_COLUMN_DELIMITER); - } - documentBuilder.append(newLine); + documentBuilder.append(formatCellContent(cellIterator.next())).append(ConfluenceMarkup.TABLE_COLUMN_DELIMITER); } + documentBuilder.append(newLine); } documentBuilder.append(newLine); return this; diff --git a/src/main/java/io/github/swagger2markup/markup/builder/internal/markdown/MarkdownBuilder.java b/src/main/java/io/github/swagger2markup/markup/builder/internal/markdown/MarkdownBuilder.java index d7da89c6..649e4995 100644 --- a/src/main/java/io/github/swagger2markup/markup/builder/internal/markdown/MarkdownBuilder.java +++ b/src/main/java/io/github/swagger2markup/markup/builder/internal/markdown/MarkdownBuilder.java @@ -21,18 +21,16 @@ package io.github.swagger2markup.markup.builder.internal.markdown; import io.github.swagger2markup.markup.builder.*; import io.github.swagger2markup.markup.builder.internal.AbstractMarkupDocBuilder; import io.github.swagger2markup.markup.builder.internal.Markup; -import org.apache.commons.collections4.CollectionUtils; -import org.apache.commons.collections4.Transformer; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.Validate; -import java.io.IOException; import java.io.Reader; import java.util.Collection; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.regex.Pattern; +import java.util.stream.Collectors; import static org.apache.commons.lang3.StringUtils.defaultString; import static org.apache.commons.lang3.StringUtils.join; @@ -185,29 +183,22 @@ public class MarkdownBuilder extends AbstractMarkupDocBuilder { @Override public MarkupDocBuilder tableWithColumnSpecs(List columnSpecs, List> cells) { - Validate.notEmpty(columnSpecs); - + Validate.notEmpty(cells, "cells must not be null"); newLine(); - Collection headerList = CollectionUtils.collect(columnSpecs, new Transformer() { - public String transform(final MarkupTableColumn header) { - return formatTableCell(defaultString(header.header)); - } - }); - documentBuilder.append(Markdown.TABLE_COLUMN_DELIMITER).append(join(headerList, Markdown.TABLE_COLUMN_DELIMITER.toString())).append(Markdown.TABLE_COLUMN_DELIMITER).append(newLine); + if (columnSpecs != null && !columnSpecs.isEmpty()) { + Collection headerList = columnSpecs.stream().map(header -> formatTableCell(defaultString(header.header))).collect(Collectors.toList()); + documentBuilder.append(Markdown.TABLE_COLUMN_DELIMITER).append(join(headerList, Markdown.TABLE_COLUMN_DELIMITER.toString())).append(Markdown.TABLE_COLUMN_DELIMITER).append(newLine); - documentBuilder.append(Markdown.TABLE_COLUMN_DELIMITER); - for (MarkupTableColumn col : columnSpecs) { - documentBuilder.append(StringUtils.repeat(Markdown.TABLE_ROW.toString(), 3)); documentBuilder.append(Markdown.TABLE_COLUMN_DELIMITER); + columnSpecs.forEach(col -> { + documentBuilder.append(StringUtils.repeat(Markdown.TABLE_ROW.toString(), 3)); + documentBuilder.append(Markdown.TABLE_COLUMN_DELIMITER); + }); + documentBuilder.append(newLine); } - documentBuilder.append(newLine); for (List row : cells) { - Collection cellList = CollectionUtils.collect(row, new Transformer() { - public String transform(final String cell) { - return formatTableCell(cell); - } - }); + Collection cellList = row.stream().map(cell -> formatTableCell(defaultString(cell))).collect(Collectors.toList()); documentBuilder.append(Markdown.TABLE_COLUMN_DELIMITER).append(join(cellList, Markdown.TABLE_COLUMN_DELIMITER.toString())).append(Markdown.TABLE_COLUMN_DELIMITER).append(newLine); } newLine();