diff --git a/redisson/src/main/java/org/redisson/api/RMap.java b/redisson/src/main/java/org/redisson/api/RMap.java index 6ef3bbcf4..3c6a10ab5 100644 --- a/redisson/src/main/java/org/redisson/api/RMap.java +++ b/redisson/src/main/java/org/redisson/api/RMap.java @@ -519,15 +519,21 @@ public interface RMap extends ConcurrentMap, RExpirable, RMapAsync * Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMap map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
      *
+     *     // or
+     *
+     *     RMap map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllValues() * * @param keyPattern - key pattern @@ -542,15 +548,21 @@ public interface RMap extends ConcurrentMap, RExpirable, RMapAsync * Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMap map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
      *
+     *     // or
+     *
+     *     RMap map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllValues() * * @param keyPattern - key pattern @@ -585,18 +597,27 @@ public interface RMap extends ConcurrentMap, RExpirable, RMapAsync10. * If keyPattern is not null then only entries mapped by matched keys of this pattern are loaded. - * + *

+ * Use org.redisson.client.codec.StringCodec for Map keys. + *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMap map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
+     *
+     *     RMap map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllEntrySet() * - * @param keyPattern - key pattern + * @param keyPattern key pattern * @return map entries collection */ Set> entrySet(String keyPattern); @@ -605,19 +626,28 @@ public interface RMap extends ConcurrentMap, RExpirable, RMapAsynccount param. * If keyPattern is not null then only entries mapped by matched keys of this pattern are loaded. - * + *

+ * Use org.redisson.client.codec.StringCodec for Map keys. + *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMap map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
+     *
+     *     RMap map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllEntrySet() * - * @param keyPattern - key pattern - * @param count - size of entries batch + * @param keyPattern key pattern + * @param count size of entries batch * @return map entries collection */ Set> entrySet(String keyPattern, int count); diff --git a/redisson/src/main/java/org/redisson/api/RMapReactive.java b/redisson/src/main/java/org/redisson/api/RMapReactive.java index 87342f011..be2982b89 100644 --- a/redisson/src/main/java/org/redisson/api/RMapReactive.java +++ b/redisson/src/main/java/org/redisson/api/RMapReactive.java @@ -417,15 +417,24 @@ public interface RMapReactive extends RExpirableReactive { * Returns iterator over map entries collection. * Map entries are loaded in batch. Batch size is 10. * If keyPattern is not null then only entries mapped by matched keys of this pattern are loaded. - * + *

+ * Use org.redisson.client.codec.StringCodec for Map keys. + *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapReactive map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
+     *
+     *     RMapReactive map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllEntrySet() * * @param pattern - key pattern @@ -437,15 +446,24 @@ public interface RMapReactive extends RExpirableReactive { * Returns iterator over map entries collection. * Map entries are loaded in batch. Batch size is defined by count param. * If keyPattern is not null then only entries mapped by matched keys of this pattern are loaded. - * + *

+ * Use org.redisson.client.codec.StringCodec for Map keys. + *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapReactive map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
+     *
+     *     RMapReactive map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllEntrySet() * * @param pattern - key pattern @@ -482,15 +500,21 @@ public interface RMapReactive extends RExpirableReactive { *

* Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapReactive map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
      *
+     *     RMapReactive map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllValues() * * @param pattern - key pattern @@ -505,15 +529,21 @@ public interface RMapReactive extends RExpirableReactive { *

* Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapReactive map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
      *
+     *     // or
+     *
+     *     RMapReactive map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllValues() * * @param pattern - key pattern diff --git a/redisson/src/main/java/org/redisson/api/RMapRx.java b/redisson/src/main/java/org/redisson/api/RMapRx.java index 8012ad164..dcf3fcf1f 100644 --- a/redisson/src/main/java/org/redisson/api/RMapRx.java +++ b/redisson/src/main/java/org/redisson/api/RMapRx.java @@ -485,15 +485,21 @@ public interface RMapRx extends RExpirableRx { *

* Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapRx map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
      *
+     *     // or
+     *
+     *     RMapRx map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllValues() * * @param pattern - key pattern @@ -508,15 +514,21 @@ public interface RMapRx extends RExpirableRx { *

* Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapRx map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
      *
+     *     RMapRx map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllValues() * * @param pattern - key pattern @@ -552,18 +564,24 @@ public interface RMapRx extends RExpirableRx { *

* Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapRx map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
      *
+     *     RMapRx map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllKeySet() * - * @param pattern - key pattern + * @param pattern key pattern * @return iterator */ Flowable keyIterator(String pattern); @@ -575,19 +593,25 @@ public interface RMapRx extends RExpirableRx { *

* Use org.redisson.client.codec.StringCodec for Map keys. *

+ * Usage example: + *

+     *     Codec valueCodec = ...
+     *     RMapRx map = redissonClient.getMap("simpleMap", new CompositeCodec(StringCodec.INSTANCE, valueCodec, valueCodec));
+     *
+     *     // or
      *
+     *     RMapRx map = redissonClient.getMap("simpleMap", StringCodec.INSTANCE);
+     * 
+ *
      *  Supported glob-style patterns:
-     *  

* h?llo subscribes to hello, hallo and hxllo - *

* h*llo subscribes to hllo and heeeello - *

* h[ae]llo subscribes to hello and hallo, but not hillo - * + *

* @see #readAllKeySet() * - * @param pattern - key pattern - * @param count - size of keys batch + * @param pattern key pattern + * @param count size of keys batch * @return iterator */ Flowable keyIterator(String pattern, int count);