Class FieldMaskUtil

Stay organized with collections Save and categorize content based on your preferences.
public final class FieldMaskUtil

Utility helper functions to work with com.google.protobuf.FieldMask.

Inheritance

java.lang.Object > FieldMaskUtil

Static Methods

<P>trim(FieldMask mask, P source)

public static P <P>trim(FieldMask mask, P source)

Returns the result of keeping only the masked fields of the given proto.

Parameters
NameDescription
maskFieldMask
sourceP
Returns
TypeDescription
P

fromFieldNumbers(Class<? extends Message> type, int[] fieldNumbers)

public static FieldMask fromFieldNumbers(Class<? extends Message> type, int[] fieldNumbers)

Constructs a FieldMask from the passed field numbers.

Parameters
NameDescription
typeClass<? extends com.google.protobuf.Message>
fieldNumbersint[]
Returns
TypeDescription
FieldMask

fromFieldNumbers(Class<? extends Message> type, Iterable<Integer> fieldNumbers)

public static FieldMask fromFieldNumbers(Class<? extends Message> type, Iterable<Integer> fieldNumbers)

Constructs a FieldMask from the passed field numbers.

Parameters
NameDescription
typeClass<? extends com.google.protobuf.Message>
fieldNumbersIterable<Integer>
Returns
TypeDescription
FieldMask

fromJsonString(String value)

public static FieldMask fromJsonString(String value)

Converts a field mask from a Proto3 JSON string, that is splitting the paths along commas and converting from camel case to snake case.

Parameter
NameDescription
valueString
Returns
TypeDescription
FieldMask

fromString(Class<? extends Message> type, String value)

public static FieldMask fromString(Class<? extends Message> type, String value)

Parses from a string to a FieldMask and validates all field paths.

Parameters
NameDescription
typeClass<? extends com.google.protobuf.Message>
valueString
Returns
TypeDescription
FieldMask

fromString(String value)

public static FieldMask fromString(String value)

Parses from a string to a FieldMask.

Parameter
NameDescription
valueString
Returns
TypeDescription
FieldMask

fromStringList(Descriptors.Descriptor descriptor, Iterable<String> paths)

public static FieldMask fromStringList(Descriptors.Descriptor descriptor, Iterable<String> paths)

Constructs a FieldMask for a list of field paths in a certain type.

Parameters
NameDescription
descriptorDescriptors.Descriptor
pathsIterable<String>
Returns
TypeDescription
FieldMask

fromStringList(Class<? extends Message> type, Iterable<String> paths)

public static FieldMask fromStringList(Class<? extends Message> type, Iterable<String> paths)

Constructs a FieldMask for a list of field paths in a certain type.

Parameters
NameDescription
typeClass<? extends com.google.protobuf.Message>
pathsIterable<String>
Returns
TypeDescription
FieldMask

fromStringList(Iterable<String> paths)

public static FieldMask fromStringList(Iterable<String> paths)

Constructs a FieldMask for a list of field paths in a certain type. Does not validate the given paths.

Parameter
NameDescription
pathsIterable<String>
Returns
TypeDescription
FieldMask

intersection(FieldMask mask1, FieldMask mask2)

public static FieldMask intersection(FieldMask mask1, FieldMask mask2)

Calculates the intersection of two FieldMasks.

Parameters
NameDescription
mask1FieldMask
mask2FieldMask
Returns
TypeDescription
FieldMask

isValid(Descriptors.Descriptor descriptor, FieldMask fieldMask)

public static boolean isValid(Descriptors.Descriptor descriptor, FieldMask fieldMask)

Checks whether paths in a given fields mask are valid.

Parameters
NameDescription
descriptorDescriptors.Descriptor
fieldMaskFieldMask
Returns
TypeDescription
boolean

isValid(Descriptors.Descriptor descriptor, String path)

public static boolean isValid(Descriptors.Descriptor descriptor, String path)

Checks whether paths in a given fields mask are valid.

Parameters
NameDescription
descriptorDescriptors.Descriptor
pathString
Returns
TypeDescription
boolean

isValid(Class<? extends Message> type, FieldMask fieldMask)

public static boolean isValid(Class<? extends Message> type, FieldMask fieldMask)

Checks whether paths in a given fields mask are valid.

Parameters
NameDescription
typeClass<? extends com.google.protobuf.Message>
fieldMaskFieldMask
Returns
TypeDescription
boolean

isValid(Class<? extends Message> type, String path)

public static boolean isValid(Class<? extends Message> type, String path)

Checks whether a given field path is valid.

Parameters
NameDescription
typeClass<? extends com.google.protobuf.Message>
pathString
Returns
TypeDescription
boolean

merge(FieldMask mask, Message source, Message.Builder destination)

public static void merge(FieldMask mask, Message source, Message.Builder destination)

Merges fields specified by a FieldMask from one message to another.

Parameters
NameDescription
maskFieldMask
sourceMessage
destinationMessage.Builder

merge(FieldMask mask, Message source, Message.Builder destination, FieldMaskUtil.MergeOptions options)

public static void merge(FieldMask mask, Message source, Message.Builder destination, FieldMaskUtil.MergeOptions options)

Merges fields specified by a FieldMask from one message to another with the specified merge options. The destination will remain unchanged if an empty FieldMask is provided.

Parameters
NameDescription
maskFieldMask
sourceMessage
destinationMessage.Builder
optionsFieldMaskUtil.MergeOptions

normalize(FieldMask mask)

public static FieldMask normalize(FieldMask mask)

Converts a FieldMask to its canonical form. In the canonical form of a FieldMask, all field paths are sorted alphabetically and redundant field paths are removed.

Parameter
NameDescription
maskFieldMask
Returns
TypeDescription
FieldMask

subtract(FieldMask firstMask, FieldMask secondMask, FieldMask[] otherMasks)

public static FieldMask subtract(FieldMask firstMask, FieldMask secondMask, FieldMask[] otherMasks)

Subtracts secondMask and otherMasks from firstMask.

This method disregards proto structure. That is, if firstMask is "foo" and secondMask is "foo.bar", the response will always be "foo" without considering the internal proto structure of message "foo".

Parameters
NameDescription
firstMaskFieldMask
secondMaskFieldMask
otherMasksFieldMask[]
Returns
TypeDescription
FieldMask

toJsonString(FieldMask fieldMask)

public static String toJsonString(FieldMask fieldMask)

Converts a field mask to a Proto3 JSON string, that is converting from snake case to camel case and joining all paths into one string with commas.

Parameter
NameDescription
fieldMaskFieldMask
Returns
TypeDescription
String

toString(FieldMask fieldMask)

public static String toString(FieldMask fieldMask)

Converts a FieldMask to a string.

Parameter
NameDescription
fieldMaskFieldMask
Returns
TypeDescription
String

union(FieldMask firstMask, FieldMask secondMask, FieldMask[] otherMasks)

public static FieldMask union(FieldMask firstMask, FieldMask secondMask, FieldMask[] otherMasks)

Creates a union of two or more FieldMasks.

Parameters
NameDescription
firstMaskFieldMask
secondMaskFieldMask
otherMasksFieldMask[]
Returns
TypeDescription
FieldMask