org.ojai.util

Class Values

java.lang.Object

org.ojai.util.Values

@API.Public
public class Values
extends Object

A helper class that provides convenience methods to operate on a Value.

Constructor Summary

Constructors

Constructor and Description
Values()

Method Summary

Modifier and Type	Method and Description
static boolean	asBoolean(Value value)
static byte	asByte(Value value)
static BigDecimal	asDecimal(Value value)
static double	asDouble(Value value)
static float	asFloat(Value value)
static int	asInt(Value value)
static String	asJsonString(Value value) Converts a Value to its extended JSON representation. The 7 intrinsic types, null, boolean, string, long, double, array, and map , are represented in regular JSON.
static long	asLong(Value value)
static Number	asNumber(Value value)
static short	asShort(Value value)
static String	asString(Value value)
static BigDecimal	parseBigDecimal(String s) Converts a string to BigDecimal object.
static ByteBuffer	parseBinary(String s) Converts a base-64 encoded string to ByteBuffer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Values

public Values()

Method Detail

asByte

public static byte asByte(@API.NonNullable
                          Value value)

Returns:

The specified value as a byte. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types

asShort

public static short asShort(@API.NonNullable
                            Value value)

Returns:

The specified value as a short. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types

asInt

public static int asInt(@API.NonNullable
                        Value value)

Returns:

The specified value as an int. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types

asLong

public static long asLong(Value value)

Returns:

The specified value as a long. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types

asFloat

public static float asFloat(Value value)

Returns:

The specified value as a float. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types

asDouble

public static double asDouble(Value value)

Returns:

The specified value as a double. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types

asDecimal

public static BigDecimal asDecimal(Value value)

Returns:

The specified value as a BigDecimal. This may involve rounding or truncation.

Throws:

IllegalArgumentException - uf the specified value is not one of the number types

asNumber

public static Number asNumber(@API.NonNullable
                              Value value)

Returns:

The specified value as a Number. This may involve rounding or truncation.

Throws:

IllegalArgumentException - if the specified value is not one of the number types or a string that can not be converted to a number.

asBoolean

public static boolean asBoolean(@API.NonNullable
                                Value value)

Returns:

The specified value as a boolean.

Throws:

IllegalArgumentException - if the specified value is not can not be converted to a boolean.

asString

public static String asString(@API.NonNullable
                              Value value)

Returns:

The specified value as a String.

parseBigDecimal

public static BigDecimal parseBigDecimal(@API.NonNullable
                                         String s)

Converts a string to BigDecimal object.

parseBinary

public static ByteBuffer parseBinary(@API.NonNullable
                                     String s)

Converts a base-64 encoded string to ByteBuffer.

asJsonString

public static String asJsonString(@API.NonNullable
                                  Value value)

Converts a Value to its extended JSON representation.

The 7 intrinsic types, null, boolean, string, long, double, array, and map , are represented in regular JSON. The extended types are converted to a singleton map with the type tag name as the key and the value of the given Value as its value. The following sample illustrates the string representation of the various types.

 {
   "map": {
     "null": null,
     "boolean" : true,
     "string": "eureka",
     "byte" : {"$numberLong": 127},
     "short": {"$numberLong": 32767},
     "int": {"$numberLong": 2147483647},
     "long": {"$numberLong":9223372036854775807},
     "float" : 3.4028235E38,
     "double" : 1.7976931348623157e308,
     "decimal": {"$decimal": "12345678901234567890189012345678901.23456789"},
     "date": {"$dateDay": "<yyyy-mm-dd>"},
     "time" : {"$time" : "<HH:mm:ss[.sss]>"},
     "timestamp" : {"$date" : "<yyyy-MM-ddTHH:mm:ss.SSSXXX>"},
     "interval" : {"$interval" : <number_of_millisecods>},
     "binary" : {"$binary" : "<base64_encoded_binary_value>"},
     "array" : [42, "open sesame", 3.14, {"$dateDay": "2015-01-21"}]
   }
 }
 

Parameters:

value - a Value that should be converted to JSON string

Returns:

The extended JSON representation of the given value