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 94db6a7 GEODE-3813: Improved and fixed formatting in javaDoc for deprecated behavior (#1500) 94db6a7 is described below commit 94db6a7d3d473fec40540c510858e60ce47cd741 Author: Jason Huynh <huyn...@gmail.com> AuthorDate: Fri Feb 23 10:57:27 2018 -0800 GEODE-3813: Improved and fixed formatting in javaDoc for deprecated behavior (#1500) --- .../main/java/org/apache/geode/cache/Region.java | 63 +++++++++++++++++----- 1 file changed, 49 insertions(+), 14 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 bf0d3bb..2a6036f 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 @@ -2014,21 +2014,39 @@ public interface Region<K, V> extends ConcurrentMap<K, V> { * cleared from the client and the current value for this key is inserted into the local cache * before this call returns. * - * @param key The key on which to register interest. 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. + * @param key The key on which to register interest. * * <p> - * This method uses the default <code>InterestResultPolicy</code>. + * ###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> + * + * <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 any type are pushed to the client and + * ".*" 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### + * + * <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 @@ -2064,22 +2082,39 @@ public interface Region<K, V> extends ConcurrentMap<K, V> { * events to your client cache. * </p> * - * @param key The key on which to register interest. 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. + * @param key The key on which to register interest. * * <p> - * This method uses the default <code>InterestResultPolicy</code>. + * ###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> + * + * <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 any type are pushed to the client and + * ".*" 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### * + * <p> + * This method uses the default <code>InterestResultPolicy</code>. + * </p> * @param isDurable true if the register interest is durable * * @param receiveValues defaults to true. set to false to receive create or update events as -- To stop receiving notification emails like this one, please contact jasonhu...@apache.org.