[02/16] ignite git commit: fixes to javadoc

[sb...@apache.org]

fixes to javadoc


Project: http://git-wip-us.apache.org/repos/asf/ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/59cfbfde
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/59cfbfde
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/59cfbfde

Branch: refs/heads/ignite-1811
Commit: 59cfbfdea535539227fd02ac2966a8f5dc42ead6
Parents: 59a893c
Author: Yakov Zhdanov <yz...@gridgain.com>
Authored: Thu Jan 14 12:54:48 2016 +0300
Committer: Yakov Zhdanov <yz...@gridgain.com>
Committed: Thu Jan 14 12:54:48 2016 +0300

----------------------------------------------------------------------
 .../discovery/tcp/ipfinder/TcpDiscoveryIpFinder.java  | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/ignite/blob/59cfbfde/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/TcpDiscoveryIpFinder.java
----------------------------------------------------------------------
diff --git a/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/TcpDiscoveryIpFinder.java b/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/TcpDiscoveryIpFinder.java
index 1e112c4..d277a3a 100644
--- a/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/TcpDiscoveryIpFinder.java
+++ b/modules/core/src/main/java/org/apache/ignite/spi/discovery/tcp/ipfinder/TcpDiscoveryIpFinder.java
@@ -61,9 +61,17 @@ public interface TcpDiscoveryIpFinder {
     /**
      * Checks whether IP finder is shared or not.
      * <p>
-     * If it is shared then only coordinator can unregister addresses.
+     * If this property is set to {@code true} then IP finder allows to add and remove
+     * addresses in runtime and this is how, for example, IP finder should work in
+     * Amazon EC2 environment or any other environment where IPs may not be known beforehand.
      * <p>
-     * All nodes should register their address themselves, as early as possible on node start.
+     * If this property is set to {@code false} then IP finder is immutable and all the addresses
+     * should be listed in configuration before Ignite start. This is the most use case for IP finders
+     * local to current VM. Since, usually such IP finders are created per each Ignite instance and
+     * all the known IPs are listed right away, but there is also an option to make such IP finders shared
+     * by setting this property to {@code true} and literally share it between local VM Ignite instances.
+     * This way user does not have to list any IPs before start, instead all starting nodes add their addresses
+     * to the finder, then get the registered addresses and continue with discovery procedure.
      *
      * @return {@code true} if IP finder is shared.
      */
@@ -95,4 +103,4 @@ public interface TcpDiscoveryIpFinder {
      * Closes this IP finder and releases any system resources associated with it.
      */
     public void close();
-}
\ No newline at end of file
+}