geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jasonhu...@apache.org
Subject [geode] branch develop updated: GEODE-3813: Improved and fixed formatting in javaDoc for deprecated behavior (#1473)
Date Tue, 20 Feb 2018 18:27:55 GMT
This is an automated email from the ASF dual-hosted git repository.

jasonhuynh pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git


The following commit(s) were added to refs/heads/develop by this push:
     new 6f11ce7  GEODE-3813: Improved and fixed formatting in javaDoc for deprecated behavior
(#1473)
6f11ce7 is described below

commit 6f11ce780ecc55eb09a8ebe3abd0e003f4a5ff79
Author: Jason Huynh <huynhja@gmail.com>
AuthorDate: Tue Feb 20 10:27:51 2018 -0800

    GEODE-3813: Improved and fixed formatting in javaDoc for deprecated behavior (#1473)
---
 .../main/java/org/apache/geode/cache/Region.java   | 103 ++++++++++++++-------
 1 file changed, 70 insertions(+), 33 deletions(-)

diff --git a/geode-core/src/main/java/org/apache/geode/cache/Region.java b/geode-core/src/main/java/org/apache/geode/cache/Region.java
index a933e51..bf0d3bb 100644
--- a/geode-core/src/main/java/org/apache/geode/cache/Region.java
+++ b/geode-core/src/main/java/org/apache/geode/cache/Region.java
@@ -1512,26 +1512,37 @@ public interface Region<K, V> extends ConcurrentMap<K, V>
{
    *
    * @param key The key on which to register interest.
    *
-   *        The following <code>List</code> and 'ALL_KEYS' behavior is now deprecated.
As an
-   *        alternative, please use {@link #registerInterestForKeys(Iterable)} and
-   *        {@link #registerInterestForAllKeys()}
+   *        <p>
+   *        ###Deprecated behavior###
+   *        </p>
+   *        <p>
+   *        The following <code>List</code> and
+   *        'ALL_KEYS' behavior is now deprecated. As an alternative, please use
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy)}
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForAllKeys(InterestResultPolicy)}
+   *        </p>
    *
-   *        Deprecated behavior: If the key is a <code>List</code>, then all
the keys in the
+   *        <p>
+   *        If the key is a <code>List</code>, then all the keys in the
    *        <code>List</code> will be registered. The key can also be the special
token 'ALL_KEYS',
    *        which will register interest in all keys in the region. In effect, this will
cause an
    *        update to any key in this region in the CacheServer to be pushed to the client.
-   *
-   *        <p>
-   *        This method uses the default <code>InterestResultPolicy</code>.
    *        </p>
    *
    *        <p>
-   *        <i> Using 'ALL_KEYS' is the same as calling {@link #registerInterestRegex(String)}
with
-   *        ".*" as the argument. This means that all keys any type are pushed to the client
and
+   *        <i>Using 'ALL_KEYS' is the same as calling {@link #registerInterestRegex(String)}
with
+   *        ".*" as the argument. This means that all keys of any type are pushed to the
client and
    *        inserted into the local cache.</i>
    *        </p>
+   *        ###End of deprecation###
    *
-   *        End of deprecation
+   *        <p>
+   *        This method uses the default <code>InterestResultPolicy</code>.
+   *        </p>
    *
    *        <p>
    *        If you locally-destroy a key and your region has concurrency-checks-enabled turned
off
@@ -1565,22 +1576,35 @@ public interface Region<K, V> extends ConcurrentMap<K, V>
{
    * events to your client cache.
    * </p>
    *
-   * @param key The key on which to register interest. The following <code>List</code>
and
+   * @param key The key on which to register interest.
+   *
+   *        <p>
+   *        ###Deprecated behavior###
+   *        </p>
+   *        <p>
+   *        The following <code>List</code> and
    *        'ALL_KEYS' behavior is now deprecated. As an alternative, please use
-   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy)} and
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy)}
+   *        </p>
+   *        <p>
    *        {@link #registerInterestForAllKeys(InterestResultPolicy)}
+   *        </p>
    *
-   *        Deprecated behavior: If the key is a <code>List</code>, then all
the keys in the
+   *        <p>
+   *        If the key is a <code>List</code>, then all the keys in the
    *        <code>List</code> will be registered. The key can also be the special
token 'ALL_KEYS',
    *        which will register interest in all keys in the region. In effect, this will
cause an
    *        update to any key in this region in the CacheServer to be pushed to the client.
+   *        </p>
    *
    *        <p>
    *        <i>Using 'ALL_KEYS' is the same as calling {@link #registerInterestRegex(String)}
with
    *        ".*" as the argument. This means that all keys of any type are pushed to the
client and
    *        inserted into the local cache.</i>
    *        </p>
-   *        End of deprecation
+   *        ###End of deprecation###
    *
    * @param policy The interest result policy. This can be one of:
    *        <ul>
@@ -2088,18 +2112,25 @@ public interface Region<K, V> extends ConcurrentMap<K, V>
{
    *
    * @param key The key on which to register interest.
    *
-   *        The following <code>List</code> and 'ALL_KEYS' behavior is now deprecated.
As an
-   *        alternative, please use
-   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy, boolean, boolean)}
and
-   *        {@link #registerInterestForAllKeys(InterestResultPolicy, boolean, boolean)}
+   *        <p>
+   *        ###Deprecated behavior###
+   *        </p>
+   *        <p>
+   *        The following <code>List</code> and
+   *        'ALL_KEYS' behavior is now deprecated. As an alternative, please use
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy)}
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForAllKeys(InterestResultPolicy)}
+   *        </p>
    *
-   *        Deprecated behavior: If the key is a <code>List</code>, then all
the keys in the
+   *        <p>
+   *        If the key is a <code>List</code>, then all the keys in the
    *        <code>List</code> will be registered. The key can also be the special
token 'ALL_KEYS',
    *        which will register interest in all keys in the region. In effect, this will
cause an
    *        update to any key in this region in the CacheServer to be pushed to the client.
-   *
-   *        <p>
-   *        This method uses the default <code>InterestResultPolicy</code>.
    *        </p>
    *
    *        <p>
@@ -2107,7 +2138,7 @@ public interface Region<K, V> extends ConcurrentMap<K, V>
{
    *        ".*" as the argument. This means that all keys of any type are pushed to the
client and
    *        inserted into the local cache.</i>
    *        </p>
-   *        End of deprecation.
+   *        ###End of deprecation###
    *
    * @param policy The interest result policy. This can be one of:
    *        <ul>
@@ -2141,18 +2172,25 @@ public interface Region<K, V> extends ConcurrentMap<K, V>
{
    *
    * @param key The key on which to register interest.
    *
-   *        The following <code>List</code> and 'ALL_KEYS' behavior is now deprecated.
As an
-   *        alternative, please use
-   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy, boolean)} and
-   *        {@link #registerInterestForAllKeys(InterestResultPolicy, boolean)}
+   *        <p>
+   *        ###Deprecated behavior###
+   *        </p>
+   *        <p>
+   *        The following <code>List</code> and
+   *        'ALL_KEYS' behavior is now deprecated. As an alternative, please use
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForKeys(Iterable, InterestResultPolicy)}
+   *        </p>
+   *        <p>
+   *        {@link #registerInterestForAllKeys(InterestResultPolicy)}
+   *        </p>
    *
-   *        Deprecated behavior: If the key is a <code>List</code>, then all
the keys in the
+   *        <p>
+   *        If the key is a <code>List</code>, then all the keys in the
    *        <code>List</code> will be registered. The key can also be the special
token 'ALL_KEYS',
    *        which will register interest in all keys in the region. In effect, this will
cause an
    *        update to any key in this region in the CacheServer to be pushed to the client.
-   *
-   *        <p>
-   *        This method uses the default <code>InterestResultPolicy</code>.
    *        </p>
    *
    *        <p>
@@ -2160,8 +2198,7 @@ public interface Region<K, V> extends ConcurrentMap<K, V>
{
    *        ".*" as the argument. This means that all keys of any type are pushed to the
client and
    *        inserted into the local cache.</i>
    *        </p>
-   *
-   *        End of deprecation.
+   *        ###End of deprecation###
    *
    *        <p>
    *        If you locally-destroy a key and your region has concurrency-checks-enabled turned
off

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

Mime
View raw message