From 9930df6e661a9a81737d4ddf0be9ca8c77f67d6f Mon Sep 17 00:00:00 2001 From: "elena.parovyshnaya" Date: Wed, 23 Oct 2019 16:48:50 +0300 Subject: [PATCH 1/6] Bug 547289 - [Passage] Provide javadoc for org.eclipse.passage.lic.api package -- added javadoc for ConditionTransportRegistry Signed-off-by: Elena Parovyshnaia --- .../ConditionTransportRegistry.java | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java index 4b7605a7c..aed5ec02d 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java @@ -14,14 +14,44 @@ import java.util.Map; +/** + * Contract for a registry of {@link ConditionTransport}s. + * + *

As {@link LicensingCondition} can be persisted in any form, a {@link ConditionTransport} + * is associated with a particular content type (like application/json or application/xmk). + *

+ * + * @see ConditionTransport + * @see LicensingCondition + * */ public interface ConditionTransportRegistry { + /** + * Returns an aggregate of all registered {@link ConditionTransport}s. + * + * @return all registered {@link ConditionTransport}s. + * */ Iterable getConditionTransports(); + /** + *

+ * Returns {@link ConditionTransport}, which is registered to handle (read and write) + * {@link LicensingCondition}s in the given {@code contentType}. The value is nullable. + *

+ * + * @return a {@link ConditionTransport} registered for the given {@code contentType}, if any, and {@code null} otherwise. + * @see #registerConditionTransport(ConditionTransport, Map) + * */ ConditionTransport getConditionTransportForContentType(String contentType); + /** + * Appends the {@code transport} to the registry with the given set of properties (like content type). + * */ void registerConditionTransport(ConditionTransport transport, Map properties); + /** + * Removes the {@code transport} from the registry. + * */ void unregisterConditionTransport(ConditionTransport transport, Map properties); } From 1922a01914be6e2de72235b5ec3b43947b692da8 Mon Sep 17 00:00:00 2001 From: "elena.parovyshnaya" Date: Wed, 23 Oct 2019 17:20:23 +0300 Subject: [PATCH 2/6] Bug 547289 - [Passage] Provide javadoc for org.eclipse.passage.lic.api package -- deduce and append `since` version Signed-off-by: Elena Parovyshnaia --- .../passage/lic/api/conditions/ConditionTransport.java | 4 +++- .../lic/api/conditions/ConditionTransportRegistry.java | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransport.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransport.java index cab3449d5..a91b6fa16 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransport.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransport.java @@ -17,7 +17,9 @@ import java.io.OutputStream; /** - * Transport interface for {@link LicensingCondition}(s) + * Transport interface for {@link LicensingCondition}(s). + * + * @since 0.4.0 */ public interface ConditionTransport { diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java index aed5ec02d..8cfdfd05c 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java @@ -23,6 +23,8 @@ * * @see ConditionTransport * @see LicensingCondition + * + * @since 0.4.0 * */ public interface ConditionTransportRegistry { From a06142bb451cba7d394e6a187bb860cd82b16b06 Mon Sep 17 00:00:00 2001 From: "elena.parovyshnaya" Date: Wed, 23 Oct 2019 18:34:47 +0300 Subject: [PATCH 3/6] Bug 547289 - [Passage] Provide javadoc for org.eclipse.passage.lic.api package -- javadoc formatted Signed-off-by: Elena Parovyshnaia --- .../ConditionTransportRegistry.java | 50 +++++++++++-------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java index 8cfdfd05c..fc45bf06c 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java @@ -23,37 +23,43 @@ * * @see ConditionTransport * @see LicensingCondition - * * @since 0.4.0 - * */ + */ public interface ConditionTransportRegistry { - /** - * Returns an aggregate of all registered {@link ConditionTransport}s. - * - * @return all registered {@link ConditionTransport}s. - * */ + /** + * Returns an aggregate of all registered {@link ConditionTransport}s. + * + * @return all registered {@link ConditionTransport}s. + */ Iterable getConditionTransports(); - /** - *

- * Returns {@link ConditionTransport}, which is registered to handle (read and write) - * {@link LicensingCondition}s in the given {@code contentType}. The value is nullable. - *

- * - * @return a {@link ConditionTransport} registered for the given {@code contentType}, if any, and {@code null} otherwise. - * @see #registerConditionTransport(ConditionTransport, Map) - * */ + /** + *

+ * Returns {@link ConditionTransport}, which is registered to handle (read and write) + * {@link LicensingCondition}s in the given {@code contentType}. The value is nullable. + *

+ * + * @param contentType string representation of + * @return a {@link ConditionTransport} registered for the given {@code contentType}, if any, and {@code null} otherwise. + * @see #registerConditionTransport(ConditionTransport, Map) + */ ConditionTransport getConditionTransportForContentType(String contentType); - /** - * Appends the {@code transport} to the registry with the given set of properties (like content type). - * */ + /** + * Appends the {@code transport} to the registry with the given set of properties. + * + * @param transport a transport to be registered + * @param properties the transport properties, like {@link ConditionMiner}s + */ void registerConditionTransport(ConditionTransport transport, Map properties); - /** - * Removes the {@code transport} from the registry. - * */ + /** + * Removes the {@code transport} from the registry. + * + * @param transport a transport to be unregistered + * @param properties the transport properties + */ void unregisterConditionTransport(ConditionTransport transport, Map properties); } From 6aa3ce3f24cba2e77cca75573795800fabda904b Mon Sep 17 00:00:00 2001 From: "elena.parovyshnaya" Date: Wed, 23 Oct 2019 18:42:53 +0300 Subject: [PATCH 4/6] Bug 547289 - [Passage] Provide javadoc for org.eclipse.passage.lic.api package -- added javadoc for methods parameters Signed-off-by: Elena Parovyshnaia --- .../lic/api/conditions/ConditionTransportRegistry.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java index fc45bf06c..357cb88ff 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java @@ -18,11 +18,12 @@ * Contract for a registry of {@link ConditionTransport}s. * *

As {@link LicensingCondition} can be persisted in any form, a {@link ConditionTransport} - * is associated with a particular content type (like application/json or application/xmk). + * is associated with a particular content type. *

* * @see ConditionTransport * @see LicensingCondition + * @see #getConditionTransportForContentType(String) * @since 0.4.0 */ public interface ConditionTransportRegistry { @@ -40,7 +41,7 @@ public interface ConditionTransportRegistry { * {@link LicensingCondition}s in the given {@code contentType}. The value is nullable. *

* - * @param contentType string representation of + * @param contentType string representation of content type (like application/json or application/xmk) * @return a {@link ConditionTransport} registered for the given {@code contentType}, if any, and {@code null} otherwise. * @see #registerConditionTransport(ConditionTransport, Map) */ From e9b7343517ace2280e0a7dc6e678aae813a948a7 Mon Sep 17 00:00:00 2001 From: "elena.parovyshnaya" Date: Wed, 23 Oct 2019 18:52:29 +0300 Subject: [PATCH 5/6] Bug 547289 - [Passage] Provide javadoc for org.eclipse.passage.lic.api package -- formatted javadoc Signed-off-by: Elena Parovyshnaia --- .../api/conditions/LicensingCondition.java | 64 +++++++++---------- 1 file changed, 31 insertions(+), 33 deletions(-) diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/LicensingCondition.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/LicensingCondition.java index 4a6f9c8ff..e781c5fe7 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/LicensingCondition.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/LicensingCondition.java @@ -17,66 +17,64 @@ import org.eclipse.passage.lic.api.access.PermissionEmitter; /** - * * Defines the condition to be evaluated by {@link PermissionEmitter}
* Obtained from {@link ConditionMiner} * * @since 0.5.0 - * */ public interface LicensingCondition { - /** - * Returns unique identifier of a feature under licensing. - * - * @return feature identifier - */ + /** + * Returns unique identifier of a feature under licensing. + * + * @return feature identifier + */ String getFeatureIdentifier(); - /** + /** * Returns descriptor of the feature version allowed by this licensing condition. * * @return version descriptor - * */ + */ String getMatchVersion(); - /** + /** * Returns rule of version matching, like "perfect match" or "equal or greater". * * @return match rule - * */ + */ String getMatchRule(); - /** - * Returns the validity period start date of this licensing condition. This is - * the value of its "validFrom" attribute. - * - * @return the valid from - */ + /** + * Returns the validity period start date of this licensing condition. This is + * the value of its "validFrom" attribute. + * + * @return the valid from + */ Date getValidFrom(); - /** - * Returns the validity period end date of this licensing condition. This is the - * value of its "validUntil" attribute. - * - * @return the valid until - */ + /** + * Returns the validity period end date of this licensing condition. This is the + * value of its "validUntil" attribute. + * + * @return the valid until + */ Date getValidUntil(); - /** - * The type of condition like "time" or "hardware". - * - * @return condition type - */ + /** + * The type of condition like "time" or "hardware". + * + * @return condition type + */ String getConditionType(); - /** + /** * Returns additional data encoded in a single string value. - * The expression is utilized by {@link PermissionEmitter} in conjunction with {@code conditionType} + * The expression is utilized by {@link PermissionEmitter} in conjunction with {@code conditionType} * * @return enlistment of additional information of this licencing condition - * @see PermissionEmitter - * @see #getConditionType - * */ + * @see PermissionEmitter + * @see #getConditionType + */ String getConditionExpression(); } From e6191ad02ec4a1d0bed8682a0dcd0c6f781e255a Mon Sep 17 00:00:00 2001 From: "elena.parovyshnaya" Date: Fri, 25 Oct 2019 20:01:09 +0300 Subject: [PATCH 6/6] Bug 547289 - [Passage] Provide javadoc for org.eclipse.passage.lic.api package -- correct wording as requested in code review Signed-off-by: Elena Parovyshnaia --- .../lic/api/conditions/ConditionTransportRegistry.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java index 357cb88ff..13e51c965 100644 --- a/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java +++ b/bundles/org.eclipse.passage.lic.api/src/org/eclipse/passage/lic/api/conditions/ConditionTransportRegistry.java @@ -23,7 +23,7 @@ * * @see ConditionTransport * @see LicensingCondition - * @see #getConditionTransportForContentType(String) + * @see #getConditionTransportForContentType(String) * @since 0.4.0 */ public interface ConditionTransportRegistry { @@ -48,7 +48,7 @@ public interface ConditionTransportRegistry { ConditionTransport getConditionTransportForContentType(String contentType); /** - * Appends the {@code transport} to the registry with the given set of properties. + * Adds the {@code transport} to the registry with the given set of properties. * * @param transport a transport to be registered * @param properties the transport properties, like {@link ConditionMiner}s