Class Converters

java.lang.Object
org.springframework.data.redis.connection.convert.Converters
Direct Known Subclasses:
LettuceConverters
public abstract class Converters extends Object
Common type converters.
Author:
Jennifer Hickey, Thomas Darimont, Mark Paluch, Christoph Strobl, daihuabin, John Blum, Sorokin Evgeniy, Marcin Grzejszczak

  • Constructor Details

    • Converters

      public Converters()

  • Method Details

    • identityConverter

      public static <T> Converter<T,T> identityConverter()
      Returns a Converter that always returns its input argument.
      Type Parameters:
      T - the type of the input and output objects to the function
      Returns:
      a function that always returns its input argument
      Since:
      2.5

    • stringToBooleanConverter

      @Deprecated(since="4.2", forRemoval=true) public static Converter<String,Boolean> stringToBooleanConverter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.2, use toBoolean(String) through method-reference or lambda syntax.

    • stringToProps

      @Deprecated(since="4.2", forRemoval=true) public static Converter<String, Properties> stringToProps()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.2, use toProperties(String) through method-reference or lambda syntax.

    • longToBoolean

      @Deprecated(since="4.2", forRemoval=true) public static Converter<Long,Boolean> longToBoolean()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.2, use toBoolean(Long) through method-reference or lambda syntax.

    • stringToDataType

      @Deprecated(since="4.2", forRemoval=true) public static Converter<String,DataType> stringToDataType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.2, use toDataType(String) through method-reference or lambda syntax.

    • toBit

      public static byte[] toBit(Boolean source)
      Render a boolean as bit command argument, 1 for true and 0 for false.

    • toBoolean

      public static boolean toBoolean(@Nullable Long source)
      Interpret a Redis integer reply as boolean. Only the value 1 yields true.

    • toBoolean

      public static Boolean toBoolean(String source)
      Interpret a Redis status reply as success. Only the OK reply yields true.
      Since:
      4.2

    • stringToBoolean

      public static Boolean stringToBoolean(String source)
      Alias for toBoolean(String).

    • toDataType

      public static DataType toDataType(String source)
      Resolve the DataType for a Redis TYPE reply.
      Throws:
      IllegalArgumentException - if the reply does not name a known DataType.

    • toProperties

      public static Properties toProperties(String source)
      Parse Redis INFO output to Properties. Unlike Properties.load(Reader), this converter does not interpret escape sequences so that e.g. Windows-style backslashes are preserved verbatim.
      Parameters:
      source - the INFO command response.
      Returns:
      the response parsed as Properties.

    • toProperties

      public static Properties toProperties(Map<?,?> source)
      Copy all entries of source into a new Properties instance. Entries are copied as-is, so only String keys and values are accessible through Properties.getProperty(String).

    • toClusterNode

      protected static RedisClusterNode toClusterNode(String clusterNodesLine)
      Converts the result of a single line of CLUSTER NODES into a RedisClusterNode.
      Parameters:
      clusterNodesLine -
      Returns:
      Since:
      1.7

    • toSetOfRedisClusterNodes

      public static Set<RedisClusterNode> toSetOfRedisClusterNodes(Collection<String> lines)
      Converts lines from the result of CLUSTER NODES into RedisClusterNodes.
      Parameters:
      lines -
      Returns:
      Since:
      1.7

    • toSetOfRedisClusterNodes

      public static Set<RedisClusterNode> toSetOfRedisClusterNodes(String clusterNodes)
      Converts the result of CLUSTER NODES into RedisClusterNodes.
      Parameters:
      clusterNodes -
      Returns:
      Since:
      1.7

    • toObjects

      public static List<Object> toObjects(Set<Tuple> tuples)
      Flatten Tuples into a list of alternating score and value entries as expected by ZADD.

    • toTimeMillis

      public static long toTimeMillis(String seconds, String microseconds)
      Returns the timestamp constructed from the given seconds and microseconds.
      Parameters:
      seconds - server time in seconds
      microseconds - elapsed microseconds in current second
      Returns:

    • toTimeMillis

      public static long toTimeMillis(String seconds, String microseconds, TimeUnit unit)
      Returns the timestamp constructed from the given seconds and microseconds.
      Parameters:
      seconds - server time in seconds.
      microseconds - elapsed microseconds in current second.
      unit - target unit.
      Returns:
      Since:
      2.5

    • secondsToTimeUnit

      public static long secondsToTimeUnit(long seconds, TimeUnit targetUnit)
      Converts seconds to the given TimeUnit.
      Parameters:
      seconds -
      targetUnit - must not be null.
      Returns:
      Since:
      1.8

    • secondsToTimeUnit

      public static Converter<Long,Long> secondsToTimeUnit(TimeUnit timeUnit)
      Creates a new Converter to convert from seconds to the given TimeUnit.
      Parameters:
      timeUnit - must not be null.
      Returns:
      Since:
      1.8

    • millisecondsToTimeUnit

      public static long millisecondsToTimeUnit(long milliseconds, TimeUnit targetUnit)
      Converts milliseconds to the given TimeUnit.
      Parameters:
      milliseconds -
      targetUnit - must not be null.
      Returns:
      Since:
      1.8

    • millisecondsToTimeUnit

      public static Converter<Long,Long> millisecondsToTimeUnit(TimeUnit timeUnit)
      Creates a new Converter to convert from milliseconds to the given TimeUnit.
      Parameters:
      timeUnit - must not be null.
      Returns:
      Since:
      1.8

    • deserializingGeoResultsConverter

      public static <V> Converter<GeoResults<RedisGeoCommands.GeoLocation<byte[]>>, GeoResults<RedisGeoCommands.GeoLocation<V>>> deserializingGeoResultsConverter(RedisSerializer<V> serializer)
      Converter capable of deserializing GeoResults.
      Parameters:
      serializer -
      Returns:
      Since:
      1.8

    • distanceConverterForMetric

      public static Converter<Double,Distance> distanceConverterForMetric(Metric metric)
      Converter capable of converting Double into Distance using given Metric.
      Parameters:
      metric -
      Returns:
      Since:
      1.8

    • toProperties

      public static Properties toProperties(List<String> input)
      Converts array outputs with key-value sequences (such as produced by CONFIG GET) from a List to Properties.
      Parameters:
      input - must not be null.
      Returns:
      the mapped result.
      Since:
      2.0

    • listToPropertiesConverter

      public static Converter<List<String>, Properties> listToPropertiesConverter()
      Returns a converter to convert array outputs with key-value sequences (such as produced by CONFIG GET) from a List to Properties.
      Returns:
      the converter.
      Since:
      2.0

    • mapToPropertiesConverter

      @Deprecated(since="4.2", forRemoval=true) public static <K,V> Converter<Map<K,V>, Properties> mapToPropertiesConverter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.2, use toProperties(Map) through method-reference or lambda syntax.
      Returns a converter to convert from Map to Properties.
      Returns:
      the converter.
      Since:
      2.0

    • secondsToDuration

      public static @Nullable Duration secondsToDuration(@Nullable Long seconds)
      Convert the given nullable seconds to a Duration or null.
      Parameters:
      seconds - can be null.
      Returns:
      given seconds as Duration or null.
      Since:
      2.1

    • parse

      public static <T> T parse(Object source, Class<T> targetType)
      Parse a rather generic Redis response, such as a list of something into a meaningful structure applying best effort conversion of byte[] and ByteBuffer.
      Type Parameters:
      T -
      Parameters:
      source - the source to parse
      targetType - eg. Map, String,...
      Returns:
      Since:
      2.3

    • parse

      public static Object parse(Object source, String sourcePath, Map<String,Class<?>> typeHintMap)
      Parse a rather generic Redis response, such as a list of something into a meaningful structure applying best effort conversion of byte[] and ByteBuffer based on the sourcePath and a typeHintMap
      Parameters:
      source - the source to parse
      sourcePath - the current path (use "root", for level 0).
      typeHintMap - source path to target type hints allowing wildcards (*).
      Returns:
      Since:
      2.3

    • entryOf

      public static <K,V> Map.Entry<K,V> entryOf(@Nullable K key, @Nullable V value)
      Create an Map.Entry from key and value.
      Type Parameters:
      K -
      V -
      Parameters:
      key -
      value -
      Returns:
      Since:
      2.6