You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by tr...@apache.org on 2017/10/23 04:20:46 UTC
svn commit: r1812971 - in
/jackrabbit/commons/filevault-package-maven-plugin/trunk/src:
main/java/org/apache/jackrabbit/filevault/maven/packaging/
main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/
site/markdown/
Author: tripod
Date: Mon Oct 23 04:20:45 2017
New Revision: 1812971
URL: http://svn.apache.org/viewvc?rev=1812971&view=rev
Log:
clean up javadoc
Modified:
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AbstractEmbeddedsMojo.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Dependency.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/DependencyValidator.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Embedded.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageDependency.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageId.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SubPackage.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Version.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VersionRange.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultPathFilter.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/Filter.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/FilterSet.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportMode.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilter.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilterSet.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilter.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilterSet.java
jackrabbit/commons/filevault-package-maven-plugin/trunk/src/site/markdown/howto_release.md
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AbstractEmbeddedsMojo.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AbstractEmbeddedsMojo.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AbstractEmbeddedsMojo.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/AbstractEmbeddedsMojo.java Mon Oct 23 04:20:45 2017
@@ -43,7 +43,6 @@ abstract class AbstractEmbeddedsMojo ext
/**
* Defines whether to fail the build when an embedded artifact is not
* found in the project's dependencies
- * @since 0.0.12
*/
@Parameter(property = "vault.failOnMissingEmbed", defaultValue = "false", required = true)
protected boolean failOnMissingEmbed;
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Dependency.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Dependency.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Dependency.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Dependency.java Mon Oct 23 04:20:45 2017
@@ -29,13 +29,11 @@ import org.codehaus.plexus.util.StringUt
import org.apache.jackrabbit.filevault.maven.packaging.impl.PackageInfo;
/**
- * The <code>Dependency</code> class represents a dependency to another content
- * package. A dependency consists of a group name, a package name and a version
- * range.
- * <p>
- * A dependency is declared as a <code><dependency></code> element of a list
- * style <code><dependencies></code> element:
+ * The {@code Dependency} class represents a dependency to another content package.
+ * A dependency consists of a group name, a package name and a version range.
* <p>
+ * A dependency is declared as a {@code <dependency>} element of a list
+ * style {@code <dependencies>} element:
* <pre>
* <dependency>
* <group>theGroup</group>
@@ -46,7 +44,6 @@ import org.apache.jackrabbit.filevault.m
* <p>
* The dependency can also reference a maven project dependency, this is preferred
* as it yields to more robust builds.
- * <p>
* <pre>
* <dependency>
* <groupId>theGroup</groupId>
@@ -54,12 +51,11 @@ import org.apache.jackrabbit.filevault.m
* </dependency>
* </pre>
* <p>
- * <p>
- * The <code>versionRange</code> may be indicated as a single version, in which
+ * The {@code versionRange} may be indicated as a single version, in which
* case the version range has no upper bound and defines the minimal version
* accepted. Otherwise, the version range defines a lower and upper bound of
* accepted versions, where the bounds are either included using parentheses
- * <code>()</code> or excluded using brackets <code>[]</code>.
+ * {@code ()} or excluded using brackets {@code []}
*/
public class Dependency {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/DependencyValidator.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/DependencyValidator.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/DependencyValidator.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/DependencyValidator.java Mon Oct 23 04:20:45 2017
@@ -58,6 +58,8 @@ public class DependencyValidator {
/**
* Checks if the filter roots of this package are covered by the dependencies and also checks for colliding roots
* in the dependencies.
+ *
+ * @return this validator
*/
public DependencyValidator validate() {
// check for overlapping dependency roots
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Embedded.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Embedded.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Embedded.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Embedded.java Mon Oct 23 04:20:45 2017
@@ -22,25 +22,25 @@ import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
+import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.jackrabbit.filevault.maven.packaging.impl.StringFilterSet;
/**
- * The <code>Embedded</code> class represents an embedded artifact dependency
+ * The {@code Embedded} class represents an embedded artifact dependency
* from the project descriptor. Such an embedding is declared in
- * <code><embedded></code> elements inside the list style
- * <code><embeddeds></code> element as follows:
- *
+ * {@code <embedded>} elements inside the list style
+ * {@code <embeddeds>} element as follows:
* <pre>
* <embedded>
- * <groupId>artifact.groupId.pattern</groupId>
- * <artifactId>artifact.artifactId.pattern</artifactId>
- * <scope>compile</scope>
+ * <groupId>artifact.groupId.pattern</groupId>
+ * <artifactId>artifact.artifactId.pattern</artifactId>
+ * <scope>compile</scope>
* <type>jar</type>
* <classifier>sources</classifier>
- * <filter>true</filter>
- * <target>/libs/sling/install</target>
+ * <filter>true</filter>
+ * <target>/libs/sling/install</target>
* </embedded>
* </pre>
*/
@@ -48,52 +48,42 @@ public class Embedded {
/**
* A group filter string, consisted of one or several comma separated patterns.
- * @parameter type="String"
*/
private final StringFilterSet groupId = new StringFilterSet();
/**
* A artifact filter string, consisted of one or several comma separated patterns.
- * @parameter type="String"
*/
private final StringFilterSet artifactId = new StringFilterSet();
- /**
- * @parameter
- */
+ @Parameter
private ScopeArtifactFilter scope;
- /**
- * @parameter
- * @since 0.0.4
- */
+ @Parameter
private String type;
- /**
- * @parameter
- * @since 0.0.4
- */
+ @Parameter
private String classifier;
/**
- * If <code>true</code> a filter entry will be generated for all embedded artifacts.
- * @parameter
+ * If {@code true} a filter entry will be generated for all embedded artifacts.
*/
+ @Parameter
private boolean filter;
/**
* Target location.
- * @parameter
*/
+ @Parameter
private String target;
/**
* Name to use for the artifact in the destination
- * @since 0.0.5
- * @parameter
*/
+ @Parameter
private String destFileName;
+ @Parameter
private boolean excludeTransitive;
public void setGroupId(String groupId) {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageDependency.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageDependency.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageDependency.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageDependency.java Mon Oct 23 04:20:45 2017
@@ -21,7 +21,6 @@ import java.util.ArrayList;
/**
* Implements a package dependency reference.
- * @since 2.0
*/
public class PackageDependency {
@@ -128,7 +127,7 @@ public class PackageDependency {
/**
* Checks if the given package id matches this dependency specification.
* @param id the package id
- * @return <code>true</code> if matches
+ * @return {@code true} if matches
*/
public boolean matches(PackageId id) {
return groupId.equals(id.getGroup())
@@ -138,7 +137,7 @@ public class PackageDependency {
/**
* Returns a dependency from a string. if the given id is null or an
- * empty string, <code>null</code> is returned.
+ * empty string, {@code null} is returned.
* @param str the string
* @return the dependency
*/
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageId.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageId.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageId.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/PackageId.java Mon Oct 23 04:20:45 2017
@@ -17,7 +17,7 @@
package org.apache.jackrabbit.filevault.maven.packaging;
/**
- * <code>PackageId</code> provides the basic metrics for identifying a package.
+ * {@code PackageId} provides the basic metrics for identifying a package.
* A package id consists of a group id, a name and a version.
* the group is a relative path, eg: "day/cq5/hotfix", the name and the version
* can be of any format.
@@ -201,7 +201,7 @@ public class PackageId implements Compar
/**
* Returns a package id from a id string. if the given id is null or an
- * empty string, <code>null</code> is returned.
+ * empty string, {@code null} is returned.
* @param str the string
* @return the package id
*/
@@ -259,9 +259,7 @@ public class PackageId implements Compar
/**
* Checks if this definition was constructed from a path, rather from a
* group and name.
- * @return <code>true</code> if constructed from path.
- *
- * @since 2.2.26
+ * @return {@code true} if constructed from path.
*/
public boolean isFromPath() {
return fromPath;
@@ -272,7 +270,6 @@ public class PackageId implements Compar
* includes the version, but never the extension (.zip).
*
* @return the path of this package
- * @since 2.2
*/
public String getInstallationPath() {
StringBuilder b = new StringBuilder(ETC_PACKAGES_PREFIX);
@@ -299,7 +296,6 @@ public class PackageId implements Compar
/**
* Returns the group id of this package
* @return the group id;
- * @since 2.2
*/
public String getGroup() {
return group;
@@ -316,7 +312,6 @@ public class PackageId implements Compar
/**
* Returns the version of this package or and empty string if n/a.
* @return the version of this package
- * @since 2.0
*/
public String getVersionString() {
return version.toString();
@@ -324,9 +319,8 @@ public class PackageId implements Compar
/**
* Returns a download name in the form
- * <code>name [ "-" version ] ".zip"</code>
+ * {@code name [ "-" version ] ".zip"}
* @return the download name
- * @since 2.0
*/
public String getDownloadName() {
StringBuilder str = new StringBuilder(name);
@@ -338,7 +332,7 @@ public class PackageId implements Compar
}
/**
- * Returns the version of this package or <code>null</code> if n/a.
+ * Returns the version of this package or {@code null} if n/a.
* @return the version of this package
*/
public Version getVersion() {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SubPackage.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SubPackage.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SubPackage.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/SubPackage.java Mon Oct 23 04:20:45 2017
@@ -22,67 +22,57 @@ import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
+import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.jackrabbit.filevault.maven.packaging.impl.StringFilterSet;
/**
- * The <code>Embedded</code> class represents an embedded artifact dependency
- * from the project descriptor. Such an embedding is declared in
- * <code><embedded></code> elements inside the list style
- * <code><embeddeds></code> element as follows:
- *
+ * The {@code SubPackage} class represents an subpackage artifact dependency
+ * from the project descriptor. Such a package is declared in
+ * {@code <subPackages>} elements inside the list style
+ * {@code <subPackage>} element as follows:
* <pre>
- * <embedded>
- * <groupId>artifact.groupId.pattern</groupId>
- * <artifactId>artifact.artifactId.pattern</artifactId>
- * <scope>compile</scope>
+ * <subPackage>
+ * <groupId>artifact.groupId.pattern</groupId>
+ * <artifactId>artifact.artifactId.pattern</artifactId>
+ * <scope>compile</scope>
* <type>jar</type>
* <classifier>sources</classifier>
- * <filter>true</filter>
- * </embedded>
+ * <filter>true</filter>
+ * </subPackage>
* </pre>
- *
- * @since 0.8
*/
public class SubPackage {
/**
* A group filter string, consisted of one or several comma separated patterns.
- * @parameter type="String"
*/
+ @Parameter
private final StringFilterSet groupId = new StringFilterSet();
/**
* A artifact filter string, consisted of one or several comma separated patterns.
- * @parameter type="String"
*/
+ @Parameter
private final StringFilterSet artifactId = new StringFilterSet();
- /**
- * @parameter
- */
+ @Parameter
private ScopeArtifactFilter scope;
- /**
- * @parameter
- */
+ @Parameter
private String type;
- /**
- * @parameter
- */
+ @Parameter
private String classifier;
/**
- * If <code>true</code> a filter entry will be generated for all embedded artifacts.
- * @parameter
+ * If {@code true} a filter entry will be generated for all embedded artifacts.
*/
+ @Parameter
private boolean filter;
- /**
- * @parameter
- */
+ @Parameter
private boolean excludeTransitive;
public void setGroupId(String groupId) {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VaultMojo.java Mon Oct 23 04:20:45 2017
@@ -122,8 +122,6 @@ public class VaultMojo extends AbstractE
/**
* The directory that contains the jcr_root of the content. Multiple directories can be specified as a comma separated list,
* which will act as a search path and cause the plugin to look for the first existing directory.
- *
- * @since 1.0.0
*/
@Parameter(
property = "vault.jcrRootSourceDirectory",
@@ -223,7 +221,7 @@ public class VaultMojo extends AbstractE
/**
* Defines whether the package requires root. This will become the
- * <code>requiresRoot</code> property of the properties.xml file.
+ * {@code requiresRoot} property of the properties.xml file.
*/
@Parameter(
property = "vault.requiresRoot",
@@ -233,7 +231,7 @@ public class VaultMojo extends AbstractE
/**
* Defines whether the package is allowed to contain index definitions. This will become the
- * <code>allowIndexDefinitions</code> property of the properties.xml file.
+ * {@code allowIndexDefinitions} property of the properties.xml file.
*/
@Parameter(
property = "vault.allowIndexDefinitions",
@@ -263,8 +261,6 @@ public class VaultMojo extends AbstractE
/**
* The file name patterns to exclude in addition to the ones listed in
* {@link AbstractScanner#DEFAULTEXCLUDES}. The format of each pattern is described in {@link DirectoryScanner}.
- *
- * @since 1.0.0
*/
@Parameter(property = "vault.excludes",
defaultValue="**/.vlt,**/.vltignore,**/.DS_Store",
@@ -273,7 +269,6 @@ public class VaultMojo extends AbstractE
/**
* Defines the path under which the embedded bundles are placed. defaults to '/apps/bundles/install'
- * @since 0.0.6
*/
@Parameter(property = "vault.embeddedTarget")
private String embeddedTarget;
@@ -282,8 +277,6 @@ public class VaultMojo extends AbstractE
* Defines the content package type. this is either 'application', 'content', 'container' or 'mixed'.
* If omitted, it is calculated automatically based on filter definitions. certain package types imply restrictions,
* for example, 'application' and 'content' packages are not allowed to contain sub packages or embedded bundles.
- *
- * @since 0.5.12
*/
@Parameter(property = "vault.packageType")
private PackageType packageType;
@@ -305,7 +298,6 @@ public class VaultMojo extends AbstractE
/**
* Defines additional bundle dependency via the osgi import-package entry in the manifest.
- * @since 0.5.12
*/
@Parameter(
property = "vault.importPackage",
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Version.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Version.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Version.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/Version.java Mon Oct 23 04:20:45 2017
@@ -18,7 +18,6 @@ package org.apache.jackrabbit.filevault.
/**
* Implements a package version.
- * @since 2.0
*/
public class Version implements Comparable<Version> {
@@ -49,8 +48,7 @@ public class Version implements Comparab
/**
* Creates a new version from the given string.
* @param str the version string.
- * @return the new version or {@link Version#EMPTY} if <code>str</code> is an empty string.
- * @since 2.2.4
+ * @return the new version or {@link Version#EMPTY} if {@code str} is an empty string.
*/
public static Version create(String str) {
if (str == null || str.length() == 0) {
@@ -63,8 +61,7 @@ public class Version implements Comparab
/**
* Creates a new version from version segments
* @param segments version segments
- * @return the new version or {@link Version#EMPTY} if <code>segments</code> is empty.
- * @since 2.2.4
+ * @return the new version or {@link Version#EMPTY} if {@code segments} is empty.
*/
public static Version create(String[] segments) {
if (segments == null || segments.length == 0) {
@@ -122,16 +119,18 @@ public class Version implements Comparab
/**
* Compares this version to the given one, segment by segment with a special
* "SNAPSHOT" handling.
- *
+ * <p>
* Examples:
- * "1" < "2"
- * "1.0" < "2"
- * "2.0.1" < "2.1"
- * "2.1" < "2.1.1"
- * "2.9" < "2.11"
- * "2.1" > "2.1-SNAPSHOT"
- * "2.1" > "2.1-R1234556"
- * "2.1-R12345" < "2.1-SNAPSHOT"
+ * <pre>
+ * "1" < "2"
+ * "1.0" < "2"
+ * "2.0.1" < "2.1"
+ * "2.1" < "2.1.1"
+ * "2.9" < "2.11"
+ * "2.1" > "2.1-SNAPSHOT"
+ * "2.1" > "2.1-R1234556"
+ * "2.1-R12345" < "2.1-SNAPSHOT"
+ * </pre>
*
* @param o the other version
* @return a negative integer, zero, or a positive integer as this version
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VersionRange.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VersionRange.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VersionRange.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/VersionRange.java Mon Oct 23 04:20:45 2017
@@ -18,7 +18,6 @@ package org.apache.jackrabbit.filevault.
/**
* Implements a version range
- * @since 2.0
*/
public class VersionRange {
@@ -54,9 +53,9 @@ public class VersionRange {
/**
* Creates a new version range.
- * @param low lower bound or <code>null</code>
+ * @param low lower bound or {@code null}
* @param lowIncl specifies if lower bound is inclusive
- * @param high upper bound or <code>null</code>
+ * @param high upper bound or {@code null}
* @param highIncl specifies if upper bound is inclusive
* @throws IllegalArgumentException if bounds are not valid
*/
@@ -113,15 +112,15 @@ public class VersionRange {
/**
* Returns the lower bound
- * @return the lower bound or <code>null</code>
+ * @return the lower bound or {@code null}
*/
public Version getLow() {
return low;
}
/**
- * Returns <code>true</code> if the lower bound is inclusive
- * @return <code>true</code> if the lower bound is inclusive
+ * Returns {@code true} if the lower bound is inclusive
+ * @return {@code true} if the lower bound is inclusive
*/
public boolean isLowInclusive() {
return lowIncl;
@@ -129,15 +128,15 @@ public class VersionRange {
/**
* Returns the upper bound
- * @return the upper bound or <code>null</code>
+ * @return the upper bound or {@code null}
*/
public Version getHigh() {
return high;
}
/**
- * Returns <code>true</code> if the upper bound is inclusive
- * @return <code>true</code> if the upper bound is inclusive
+ * Returns {@code true} if the upper bound is inclusive
+ * @return {@code true} if the upper bound is inclusive
*/
public boolean isHighInclusive() {
return highIncl;
@@ -162,7 +161,7 @@ public class VersionRange {
/**
* Checks if the given version is in this range.
* @param v the version to check
- * @return <code>true</code> if the given version is in this range.
+ * @return {@code true} if the given version is in this range.
*/
public boolean isInRange(Version v) {
if (low != null) {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultPathFilter.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultPathFilter.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultPathFilter.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/DefaultPathFilter.java Mon Oct 23 04:20:45 2017
@@ -46,9 +46,9 @@ public class DefaultPathFilter implement
/**
* Sets the regexp pattern for this filter.
- *
+ * <p>
* Examples:
- * <xmp>
+ * <pre>
* | Pattern | Matches
* | /foo | exactly "/foo"
* | /foo.* | all paths starting with "/foo"
@@ -56,7 +56,7 @@ public class DefaultPathFilter implement
* | /foo/[^/]*$ | all direct children of /foo
* | /foo/.* | all children of /foo
* | /foo(/.*)? | all children of /foo and foo itself
- * </xmp>
+ * </pre>
*
* @param pattern the pattern.
*/
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/Filter.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/Filter.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/Filter.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/Filter.java Mon Oct 23 04:20:45 2017
@@ -17,7 +17,7 @@
package org.apache.jackrabbit.filevault.maven.packaging.impl;
/**
- * <code>Filter</code>...
+ * {@code Filter}...
*/
public interface Filter {
}
\ No newline at end of file
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/FilterSet.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/FilterSet.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/FilterSet.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/FilterSet.java Mon Oct 23 04:20:45 2017
@@ -24,7 +24,7 @@ import java.util.List;
* The item filter set holds a set of item filters each attributed as include
* or exclude filter. The evaluation of the set allows included items and
* rejects excluded items.
- * <p/>
+ * <p>
* Additionally it contains a "root" path for which the filters are evaluated.
* if an item has not the node addressed by the root path as ancestor, it is
* always excluded.
@@ -135,7 +135,7 @@ public abstract class FilterSet<E extend
/**
* Checks if this filter set is sealed.
- * @return <code>true</code> if sealed.
+ * @return {@code true} if sealed.
*/
public boolean isSealed() {
return sealed;
@@ -144,7 +144,7 @@ public abstract class FilterSet<E extend
/**
* Adds (replaces) all entries from the given set to this one.
* @param set the set of entries
- * @return <code>this</code> suitable for chaining.
+ * @return {@code this} suitable for chaining.
*/
public FilterSet addAll(FilterSet<E> set) {
if (sealed) {
@@ -162,7 +162,7 @@ public abstract class FilterSet<E extend
/**
* Adds a new item filter as included entry.
* @param filter the filter
- * @return <code>this</code> suitable for chaining.
+ * @return {@code this} suitable for chaining.
*/
public FilterSet addInclude(E filter) {
addEntry(new Entry<E>(filter, true));
@@ -172,7 +172,7 @@ public abstract class FilterSet<E extend
/**
* Adds a new item filter as excluded entry.
* @param filter the filter
- * @return <code>this</code> suitable for chaining.
+ * @return {@code this} suitable for chaining.
*/
public FilterSet addExclude(E filter) {
addEntry(new Entry<E>(filter, false));
@@ -204,7 +204,7 @@ public abstract class FilterSet<E extend
/**
* Checks if this filter set has any entries defined.
- * @return <code>true</code> if empty
+ * @return {@code true} if empty
*/
public boolean isEmpty() {
return entries == null || entries.isEmpty();
@@ -212,10 +212,10 @@ public abstract class FilterSet<E extend
/**
* Checks if the given item is covered by this filter set. I.e. if the node
- * addressed by the <code>root</code> path is an ancestor of the given item.
+ * addressed by the {@code root} path is an ancestor of the given item.
*
* @param path path of the item
- * @return <code>true</code> if this set covers the given item
+ * @return {@code true} if this set covers the given item
*/
public boolean covers(String path) {
return path.equals(root) || path.startsWith(rootPattern);
@@ -224,7 +224,7 @@ public abstract class FilterSet<E extend
/**
* Checks if the given item is an ancestor of the root node.
* @param path path of the item to check
- * @return <code>true</code> if the given item is an ancestor
+ * @return {@code true} if the given item is an ancestor
*/
public boolean isAncestor(String path) {
return path.equals(root) || root.startsWith(path + "/") || path.equals("/");
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportMode.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportMode.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportMode.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/ImportMode.java Mon Oct 23 04:20:45 2017
@@ -17,7 +17,7 @@
package org.apache.jackrabbit.filevault.maven.packaging.impl;
/**
- * <code>ImportMode</code> is used to define how importing content is applied
+ * {@code ImportMode} is used to define how importing content is applied
* to the existing content in the repository.
*/
public enum ImportMode {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilter.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilter.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilter.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilter.java Mon Oct 23 04:20:45 2017
@@ -29,7 +29,7 @@ public interface PathFilter extends Filt
public static final PathFilter ALL = new PathFilter() {
/**
- * Returns always <code>true</code>
+ * Returns always {@code true}
*/
public boolean matches(String path) {
return true;
@@ -49,7 +49,7 @@ public interface PathFilter extends Filt
public static final PathFilter NONE = new PathFilter() {
/**
- * Returns always <code>false</code>
+ * Returns always {@code false}
*/
public boolean matches(String path) {
return false;
@@ -68,14 +68,14 @@ public interface PathFilter extends Filt
* Checks if the given path matches this filters criteria.
*
* @param path the path to check
- * @return <code>true</code> if this filter matches the criteria;
- * <code>false</code> otherwise.
+ * @return {@code true} if this filter matches the criteria;
+ * {@code false} otherwise.
*/
boolean matches(String path);
/**
* Checks if the pattern is absolute, i.e. does not start with a wildcard.
- * @return <code>true</code> if pattern is absolute
+ * @return {@code true} if pattern is absolute
*/
boolean isAbsolute();
}
\ No newline at end of file
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilterSet.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilterSet.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilterSet.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/PathFilterSet.java Mon Oct 23 04:20:45 2017
@@ -22,11 +22,10 @@ import java.util.List;
* The path filter set holds a set of path filters each attributes as include
* or exclude filter. The evaluation of the set allows included paths and
* rejects excluded paths.
- * <p/>
+ * <p>
* Additionally it contains a "root" path for which the filters are evaluated.
* if an item has not the node addressed by the root path as ancestor, it is
* always excluded.
- *
*/
public class PathFilterSet extends FilterSet<PathFilter> {
@@ -85,14 +84,14 @@ public class PathFilterSet extends Filte
/**
* Evaluates the filters if this set does {@link #covers(String) cover} the
- * given item. otherwise <code>false</code> is returned.
+ * given item. otherwise is returned.
* The result of the evaluation is the polarity of the last matched path.
- * If no filter matches it returns <code>true</code>
+ * If no filter matches it returns {@code true}
* if the first filter is an exclude filter or if no filter is defined;
- * <code>false</code> if the first filter is an include filter.
+ * {@code false} if the first filter is an include filter.
*
* @param path the path to check
- * @return <code>true</code> if this set matches the item
+ * @return {@code true} if this set matches the item
*/
public boolean contains(String path) {
if (!covers(path)) {
@@ -131,7 +130,7 @@ public class PathFilterSet extends Filte
* Checks if this path filter set only contains entries that are relative
* include patterns, eg: ".* /foo.*". in this case the aggregator will use a
* different strategy when providing non matching leave nodes.
- * @return <code>true</code> if only contains relative patterns
+ * @return {@code true} if only contains relative patterns
*/
public boolean hasOnlyRelativePatterns() {
seal();
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilter.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilter.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilter.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilter.java Mon Oct 23 04:20:45 2017
@@ -17,7 +17,7 @@
package org.apache.jackrabbit.filevault.maven.packaging.impl;
/**
- * <code>StringFilter</code>...
+ * {@code StringFilter}...
*/
public class StringFilter extends DefaultPathFilter {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilterSet.java
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilterSet.java?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilterSet.java (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/main/java/org/apache/jackrabbit/filevault/maven/packaging/impl/StringFilterSet.java Mon Oct 23 04:20:45 2017
@@ -19,7 +19,7 @@ package org.apache.jackrabbit.filevault.
import java.util.List;
/**
- * <code>StringFilterSet</code>...
+ * {@code StringFilterSet}...
*/
public class StringFilterSet extends FilterSet<StringFilter> {
Modified: jackrabbit/commons/filevault-package-maven-plugin/trunk/src/site/markdown/howto_release.md
URL: http://svn.apache.org/viewvc/jackrabbit/commons/filevault-package-maven-plugin/trunk/src/site/markdown/howto_release.md?rev=1812971&r1=1812970&r2=1812971&view=diff
==============================================================================
--- jackrabbit/commons/filevault-package-maven-plugin/trunk/src/site/markdown/howto_release.md (original)
+++ jackrabbit/commons/filevault-package-maven-plugin/trunk/src/site/markdown/howto_release.md Mon Oct 23 04:20:45 2017
@@ -35,7 +35,7 @@ Release management tasks
1. Make sure that an appropriate version for the release is entered in [Jira][3] and that all the related issues have
been resolved.
-2. Create or update a `RELEASE-NOTES.txt` file in the root folder of the project to be released. When done, commit the
+2. Create or update a `RELEASE-NOTES.md` file in the root folder of the project to be released. When done, commit the
file. See previous release notes for examples of what to include. The release note report in [Jira][3] is a useful
source of required information.