Package com.apple.foundationdb.record.metadata.expressions

Class TupleFieldsHelper

java.lang.Object

com.apple.foundationdb.record.metadata.expressions.TupleFieldsHelper

@API(INTERNAL)
public class TupleFieldsHelper
extends Object

Static methods for dealing with special field types that are messages in protobuf but single items in Tuples.

Method Summary

Modifier and Type	Method	Description
static boolean	fromProto(TupleFieldsProto.NullableBool proto)	Convert a Protobuf NullableBool to a Java boolean.
static ByteString	fromProto(TupleFieldsProto.NullableBytes proto)	Convert a Protobuf NullableBytes to a Java ByteString.
static double	fromProto(TupleFieldsProto.NullableDouble proto)	Convert a Protobuf NullableDouble to a Java double.
static float	fromProto(TupleFieldsProto.NullableFloat proto)	Convert a Protobuf NullableFloat to a Java float.
static int	fromProto(TupleFieldsProto.NullableInt32 proto)	Convert a Protobuf NullableInt32 to a Java int.
static long	fromProto(TupleFieldsProto.NullableInt64 proto)	Convert a Protobuf NullableInt64 to a Java long.
static String	fromProto(TupleFieldsProto.NullableString proto)	Convert a Protobuf NullableString to a Java String.
static UUID	fromProto(TupleFieldsProto.UUID proto)	Convert a Protobuf UUID to a Java UUID.
static Object	fromProto(Message value, Descriptors.Descriptor descriptor)	Convert a field's value from a message to a Tuple item.
static boolean	isTupleField(Descriptors.Descriptor descriptor)	Test whether a message field's descriptor is one of the special ones.
static TupleFieldsProto.NullableBool	toProto(boolean value)	Convert a Java boolean to a Protobuf NullableBool.
static TupleFieldsProto.NullableDouble	toProto(double value)	Convert a Java double to a Protobuf NullableDouble.
static TupleFieldsProto.NullableFloat	toProto(float value)	Convert a Java float to a Protobuf NullableFloat.
static TupleFieldsProto.NullableInt32	toProto(int value)	Convert a Java int to a Protobuf NullableInt32.
static TupleFieldsProto.NullableInt64	toProto(long value)	Convert a Java long to a Protobuf NullableInt64.
static TupleFieldsProto.NullableBytes	toProto(ByteString value)	Convert a Java ByteString to a Protobuf NullableBytes.
static Message	toProto(Object value, Descriptors.Descriptor descriptor)	Convert a field's value from a Tuple item to a message.
static TupleFieldsProto.NullableString	toProto(String value)	Convert a Java String to a Protobuf NullableString.
static TupleFieldsProto.UUID	toProto(UUID uuid)	Convert a Java UUID to a Protobuf UUID.

Methods inherited from class java.lang.Object

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

Method Detail

isTupleField

public static boolean isTupleField(@Nonnull
                                   Descriptors.Descriptor descriptor)

Test whether a message field's descriptor is one of the special ones.

Parameters:

descriptor - message descriptor for the field

Returns:

true if the field is decoded into a single item in a Tuple.

fromProto

@Nonnull
public static Object fromProto(@Nonnull
                               Message value,
                               @Nonnull
                               Descriptors.Descriptor descriptor)

Convert a field's value from a message to a Tuple item.

Parameters:

value - value for the field

descriptor - message descriptor for the field

Returns:

an object suitable for storing in a Tuple

fromProto

@Nonnull
public static UUID fromProto(@Nonnull
                             TupleFieldsProto.UUID proto)

Convert a Protobuf UUID to a Java UUID.

Parameters:

proto - the value of a Protobuf UUID field

Returns:

the decoded Java UUID

fromProto

public static double fromProto(@Nonnull
                               TupleFieldsProto.NullableDouble proto)

Convert a Protobuf NullableDouble to a Java double.

Parameters:

proto - the value of a Protobuf NullableDouble field

Returns:

the decoded Java double

fromProto

public static float fromProto(@Nonnull
                              TupleFieldsProto.NullableFloat proto)

Convert a Protobuf NullableFloat to a Java float.

Parameters:

proto - the value of a Protobuf NullableFloat field

Returns:

the decoded Java float

fromProto

public static int fromProto(@Nonnull
                            TupleFieldsProto.NullableInt32 proto)

Convert a Protobuf NullableInt32 to a Java int.

Parameters:

proto - the value of a Protobuf NullableInt32 field

Returns:

the decoded Java int

fromProto

public static long fromProto(@Nonnull
                             TupleFieldsProto.NullableInt64 proto)

Convert a Protobuf NullableInt64 to a Java long.

Parameters:

proto - the value of a Protobuf NullableInt64 field

Returns:

the decoded Java long

fromProto

public static boolean fromProto(@Nonnull
                                TupleFieldsProto.NullableBool proto)

Convert a Protobuf NullableBool to a Java boolean.

Parameters:

proto - the value of a Protobuf NullableBool field

Returns:

the decoded Java boolean

fromProto

@Nonnull
public static String fromProto(@Nonnull
                               TupleFieldsProto.NullableString proto)

Convert a Protobuf NullableString to a Java String.

Parameters:

proto - the value of a Protobuf NullableString field

Returns:

the decoded Java String

fromProto

@Nonnull
public static ByteString fromProto(@Nonnull
                                   TupleFieldsProto.NullableBytes proto)

Convert a Protobuf NullableBytes to a Java ByteString.

Parameters:

proto - the value of a Protobuf NullableBytes field

Returns:

the decoded Java ByteString

toProto

@Nonnull
public static Message toProto(@Nonnull
                              Object value,
                              @Nonnull
                              Descriptors.Descriptor descriptor)

Convert a field's value from a Tuple item to a message.

Parameters:

value - value for the field

descriptor - message descriptor for the field

Returns:

an object suitable for storing in the field

toProto

@Nonnull
public static TupleFieldsProto.UUID toProto(@Nonnull
                                            UUID uuid)

Convert a Java UUID to a Protobuf UUID.

Parameters:

uuid - the Java UUID

Returns:

a message to set as the value of a Protobuf UUID field

toProto

@Nonnull
public static TupleFieldsProto.NullableDouble toProto(double value)

Convert a Java double to a Protobuf NullableDouble.

Parameters:

value - the Java double

Returns:

a message to set as the value of a Protobuf NullableDouble field

toProto

@Nonnull
public static TupleFieldsProto.NullableFloat toProto(float value)

Convert a Java float to a Protobuf NullableFloat.

Parameters:

value - the Java float

Returns:

a message to set as the value of a Protobuf NullableFloat field

toProto

@Nonnull
public static TupleFieldsProto.NullableInt32 toProto(int value)

Convert a Java int to a Protobuf NullableInt32.

Parameters:

value - the Java int

Returns:

a message to set as the value of a Protobuf NullableInt32 field

toProto

@Nonnull
public static TupleFieldsProto.NullableInt64 toProto(long value)

Convert a Java long to a Protobuf NullableInt64.

Parameters:

value - the Java long

Returns:

a message to set as the value of a Protobuf NullableInt64 field

toProto

@Nonnull
public static TupleFieldsProto.NullableBool toProto(boolean value)

Convert a Java boolean to a Protobuf NullableBool.

Parameters:

value - the Java boolean

Returns:

a message to set as the value of a Protobuf NullableBool field

toProto

@Nonnull
public static TupleFieldsProto.NullableString toProto(@Nonnull
                                                      String value)

Convert a Java String to a Protobuf NullableString.

Parameters:

value - the Java String

Returns:

a message to set as the value of a Protobuf NullableString field

toProto

@Nonnull
public static TupleFieldsProto.NullableBytes toProto(@Nonnull
                                                     ByteString value)

Convert a Java ByteString to a Protobuf NullableBytes.

Parameters:

value - the Java ByteString

Returns:

a message to set as the value of a Protobuf NullableBytes field