[jackrabbit-filevault] branch master updated: clarify javadoc for string representations of dependencies and version ranges

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git


The following commit(s) were added to refs/heads/master by this push:
     new ef03201  clarify javadoc for string representations of dependencies and version ranges
ef03201 is described below

commit ef032011683613cd66cd6dc36c537e7dd08ef8e0
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Wed Mar 31 14:13:27 2021 +0200

    clarify javadoc for string representations of dependencies and version
    ranges
---
 .../java/org/apache/jackrabbit/vault/packaging/Dependency.java    | 3 +++
 .../java/org/apache/jackrabbit/vault/packaging/VersionRange.java  | 8 ++++++++
 2 files changed, 11 insertions(+)

diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/Dependency.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/Dependency.java
index 1173441..0222a37 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/Dependency.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/Dependency.java
@@ -25,7 +25,10 @@ import org.jetbrains.annotations.Nullable;
 
 /**
  * Implements a package dependency reference.
+ * 
+ * The string representation is {@code <group>:<name>[:<versionrange>]}
  * @since 2.0
+ * @see VersionRange
  */
 public class Dependency {
 
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/VersionRange.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/VersionRange.java
index 6e56d36..c6bcf74 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/VersionRange.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/VersionRange.java
@@ -19,6 +19,14 @@ package org.apache.jackrabbit.vault.packaging;
 
 /**
  * Implements a version range
+ * 
+ * The string representation is either 
+ * <ul>
+ * <li>the empty string, which means all versions match</li>
+ * <li>or a simple version string consisting of arbitrarily many alphanumeric segments separated by {@code .}. Those segments must not include a {@code ,}. This means
+ * everything from the given version will match (i.e. upper bound unlimited).
+ * <li>or a real range in the form {@code '['|'('<lowerBound>,(<upperBound>']'|')')}, where {@code []} means inclusive and {@code ()} means exclusive bounds. Both the lowerBound and upperBound must follow the grammar from the simple version string.
+ * 
  * @since 2.0
  */
 public class VersionRange {