Modifier and Type | Class and Description |
---|---|
static class |
FieldMaskUtil.MergeOptions
Options to customize merging behavior.
|
Modifier and Type | Method and Description |
---|---|
static FieldMask |
fromFieldNumbers(Class<? extends Message> type,
int... fieldNumbers)
Constructs a FieldMask from the passed field numbers.
|
static FieldMask |
fromFieldNumbers(Class<? extends Message> type,
Iterable<Integer> fieldNumbers)
Constructs a FieldMask from the passed field numbers.
|
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.
|
static FieldMask |
fromString(Class<? extends Message> type,
String value)
Parses from a string to a FieldMask and validates all field paths.
|
static FieldMask |
fromString(String value)
Parses from a string to a FieldMask.
|
static FieldMask |
fromStringList(Class<? extends Message> type,
Iterable<String> paths)
Constructs a FieldMask for a list of field paths in a certain type.
|
static FieldMask |
intersection(FieldMask mask1,
FieldMask mask2)
Calculates the intersection of two FieldMasks.
|
static boolean |
isValid(Class<? extends Message> type,
FieldMask fieldMask)
Checks whether paths in a given fields mask are valid.
|
static boolean |
isValid(Class<? extends Message> type,
String path)
Checks whether a given field path is valid.
|
static boolean |
isValid(Descriptors.Descriptor descriptor,
FieldMask fieldMask)
Checks whether paths in a given fields mask are valid.
|
static boolean |
isValid(Descriptors.Descriptor descriptor,
String path)
Checks whether paths in a given fields mask are valid.
|
static void |
merge(FieldMask mask,
Message source,
Message.Builder destination)
Merges fields specified by a FieldMask from one message to another.
|
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.
|
static FieldMask |
normalize(FieldMask mask)
Converts a FieldMask to its canonical form.
|
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.
|
static String |
toString(FieldMask fieldMask)
Converts a FieldMask to a string.
|
static FieldMask |
union(FieldMask firstMask,
FieldMask secondMask,
FieldMask... otherMasks)
Creates a union of two or more FieldMasks.
|
public static FieldMask fromString(Class<? extends Message> type, String value)
IllegalArgumentException
- if any of the field path is invalid.public static FieldMask fromStringList(Class<? extends Message> type, Iterable<String> paths)
IllegalArgumentException
- if any of the field path is not valid.public static FieldMask fromFieldNumbers(Class<? extends Message> type, int... fieldNumbers)
IllegalArgumentException
- if any of the fields are invalid for the message.public static FieldMask fromFieldNumbers(Class<? extends Message> type, Iterable<Integer> fieldNumbers)
IllegalArgumentException
- if any of the fields are invalid for the message.public static String toJsonString(FieldMask fieldMask)
public static FieldMask fromJsonString(String value)
public static boolean isValid(Class<? extends Message> type, FieldMask fieldMask)
public static boolean isValid(Descriptors.Descriptor descriptor, FieldMask fieldMask)
public static boolean isValid(Class<? extends Message> type, String path)
public static boolean isValid(Descriptors.Descriptor descriptor, String path)
public static FieldMask normalize(FieldMask mask)
public static FieldMask union(FieldMask firstMask, FieldMask secondMask, FieldMask... otherMasks)
public static FieldMask intersection(FieldMask mask1, FieldMask mask2)
public static void merge(FieldMask mask, Message source, Message.Builder destination, FieldMaskUtil.MergeOptions options)
public static void merge(FieldMask mask, Message source, Message.Builder destination)
Copyright © 2008–2020. All rights reserved.