You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2018/05/04 17:11:34 UTC

[sling-org-apache-sling-discovery-api] branch master updated: fix javadoc

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

olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-discovery-api.git


The following commit(s) were added to refs/heads/master by this push:
     new 2d298ac  fix javadoc
2d298ac is described below

commit 2d298acb728b76f7cc2b486dddbe1b824ac7b7dc
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Fri May 4 19:11:30 2018 +0200

    fix javadoc
---
 .../java/org/apache/sling/discovery/DiscoveryService.java     |  2 +-
 .../java/org/apache/sling/discovery/InstanceDescription.java  | 11 ++++++-----
 src/main/java/org/apache/sling/discovery/InstanceFilter.java  |  6 +++---
 .../java/org/apache/sling/discovery/PropertyProvider.java     |  3 ++-
 4 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/src/main/java/org/apache/sling/discovery/DiscoveryService.java b/src/main/java/org/apache/sling/discovery/DiscoveryService.java
index 70f5a72..9983ae4 100644
--- a/src/main/java/org/apache/sling/discovery/DiscoveryService.java
+++ b/src/main/java/org/apache/sling/discovery/DiscoveryService.java
@@ -35,7 +35,7 @@ public interface DiscoveryService {
 	 * <p>
 	 * If for some reason the service is currently not able to do topology discovery
 	 * it will return the last valid topology marked with <code>false</code> in the call
-	 * to <codeTopologyView.isCurrent()</code>. This is also true if the service
+	 * to <code>TopologyView.isCurrent()</code>. This is also true if the service
 	 * has noticed a potential change in the topology and is in the process of
 	 * settling the change in the topology (eg with peers, ie voting).
 	 * <p>
diff --git a/src/main/java/org/apache/sling/discovery/InstanceDescription.java b/src/main/java/org/apache/sling/discovery/InstanceDescription.java
index e048368..3cf3997 100644
--- a/src/main/java/org/apache/sling/discovery/InstanceDescription.java
+++ b/src/main/java/org/apache/sling/discovery/InstanceDescription.java
@@ -56,7 +56,7 @@ public interface InstanceDescription {
 
     /**
 	 * Returns the ClusterView of which this instance is part of.
-	 * <p>
+	 *
 	 * Every instance is part of a ClusterView even if it is standalone.
 	 * @return the ClusterView
 	 */
@@ -65,9 +65,9 @@ public interface InstanceDescription {
 	/**
 	 * If an instance is part of a cluster, it can potentially be a leader of that cluster -
 	 * this information is queried here.
-	 * <p>
+	 *
 	 * If an instance is not part of a cluster, this method returns true.
-	 * <p>
+	 *
 	 * Only one instance of a cluster is guaranteed to be the leader at any time.
 	 * This guarantee is provided by this service.
 	 * If the leader goes down, the service elects a new leader and announces it to
@@ -85,17 +85,18 @@ public interface InstanceDescription {
 
     /**
      * The identifier of the running Sling instance.
+	 *
+	 * @return the identifier of this instance
      */
     String getSlingId();
 
     /**
      * Returns the value of a particular property.
-     * <p>
+	 *
      * Note that there are no hard guarantees or requirements as to how quickly
      * a property is available once it is set on a distant instance.
      * @param name The property name
      * @return The value of the property or <code>null</code>
-     * @see DiscoveryService#setProperty(String, String)
      */
     String getProperty(final String name);
 
diff --git a/src/main/java/org/apache/sling/discovery/InstanceFilter.java b/src/main/java/org/apache/sling/discovery/InstanceFilter.java
index 94d621a..f74693c 100644
--- a/src/main/java/org/apache/sling/discovery/InstanceFilter.java
+++ b/src/main/java/org/apache/sling/discovery/InstanceFilter.java
@@ -22,15 +22,15 @@ import org.osgi.annotation.versioning.ConsumerType;
 
 /**
  * Used to filter InstanceDescriptions in a TopologyView.
- * <p>
- * @see DiscoveryService#findInstances(InstanceFilter)
+ * 
+ * @see TopologyView#findInstances(InstanceFilter)
  */
 @ConsumerType
 public interface InstanceFilter {
 
 	/**
 	 * Returns true if this InstanceFilter selects the given InstanceDescription.
-	 * <p>
+	 *
 	 * @param instance the InstanceDescription for which to decide if this
 	 * InstanceFilter accepts it or not.
 	 * @return true if this InstanceFilter selects the given InstanceDescription
diff --git a/src/main/java/org/apache/sling/discovery/PropertyProvider.java b/src/main/java/org/apache/sling/discovery/PropertyProvider.java
index c6e15db..e0c3fe9 100644
--- a/src/main/java/org/apache/sling/discovery/PropertyProvider.java
+++ b/src/main/java/org/apache/sling/discovery/PropertyProvider.java
@@ -46,9 +46,10 @@ public interface PropertyProvider {
 	/**
 	 * Retrieves a property that is subsequently set on the local instance
 	 * and broadcast to the <code>TopologyView</code> instances.
-	 * <p>
+	 *
 	 * These properties are non-persistent and disappear after the local instance goes down.
 	 *
+	 * @param name The property name
 	 * @return The value of the property or <code>null</code>. If the property
 	 *         value can't be provided or if the provider does not support this
 	 *         property, it must return <code>null</code>.

-- 
To stop receiving notification emails like this one, please contact
olli@apache.org.