Classes
class	MergeOptions

Static Public Member Functions
static FieldMask	fromFieldNumbers (Class<? extends Message > type, int... fieldNumbers)

static FieldMask	fromFieldNumbers (Class<? extends Message > type, int... fieldNumbers)

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

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

static FieldMask	fromJsonString (String value)

static FieldMask	fromJsonString (String value)

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

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

static FieldMask	fromString (String value)

static FieldMask	fromString (String value)

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

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

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

static FieldMask	fromStringList (Iterable< String > paths)

static FieldMask	intersection (FieldMask mask1, FieldMask mask2)

static FieldMask	intersection (FieldMask mask1, FieldMask mask2)

static boolean	isValid (@Nullable Descriptor descriptor, String path)

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

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

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

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

static boolean	isValid (Descriptor descriptor, FieldMask fieldMask)

static boolean	isValid (Descriptor descriptor, FieldMask fieldMask)

static boolean	isValid (Descriptor descriptor, String path)

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

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

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

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

static FieldMask	normalize (FieldMask mask)

static FieldMask	normalize (FieldMask mask)

static FieldMask	subtract (FieldMask firstMask, FieldMask secondMask, FieldMask... otherMasks)

static String	toJsonString (FieldMask fieldMask)

static String	toJsonString (FieldMask fieldMask)

static String	toString (FieldMask fieldMask)

static String	toString (FieldMask fieldMask)

static< P extends Message > P	trim (FieldMask mask, P source)

static FieldMask	union (FieldMask firstMask, FieldMask secondMask, FieldMask... otherMasks)

static FieldMask	union (FieldMask firstMask, FieldMask secondMask, FieldMask... otherMasks)

Private Member Functions
	FieldMaskUtil ()

	FieldMaskUtil ()

Static Private Member Functions
static FieldMask	fromStringList (Optional< Descriptor > descriptor, Iterable< String > paths)

Static Private Attributes
static final String	FIELD_PATH_SEPARATOR = ","

static final String	FIELD_PATH_SEPARATOR_REGEX = ","

static final String	FIELD_SEPARATOR_REGEX = "\\."

Detailed Description

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

Definition at line 52 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

Constructor & Destructor Documentation

◆ FieldMaskUtil() [1/2]

com.google.protobuf.util.FieldMaskUtil.FieldMaskUtil ( )

inlineprivate

Definition at line 57 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ FieldMaskUtil() [2/2]

com.google.protobuf.util.FieldMaskUtil.FieldMaskUtil ( )

inlineprivate

Definition at line 59 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

Member Function Documentation

◆ fromFieldNumbers() [1/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromFieldNumbers	(	Class<? extends Message >	type,
		int...	fieldNumbers
	)

inlinestatic

Constructs a FieldMask from the passed field numbers.

Exceptions

IllegalArgumentException if any of the fields are invalid for the message.

Definition at line 125 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromFieldNumbers() [2/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromFieldNumbers	(	Class<? extends Message >	type,
		int...	fieldNumbers
	)

inlinestatic

Constructs a FieldMask from the passed field numbers.

Exceptions

IllegalArgumentException if any of the fields are invalid for the message.

Definition at line 149 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromFieldNumbers() [3/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromFieldNumbers	(	Class<? extends Message >	type,
		Iterable< Integer >	fieldNumbers
	)

inlinestatic

Constructs a FieldMask from the passed field numbers.

Exceptions

IllegalArgumentException if any of the fields are invalid for the message.

Definition at line 134 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromFieldNumbers() [4/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromFieldNumbers	(	Class<? extends Message >	type,
		Iterable< Integer >	fieldNumbers
	)

inlinestatic

Constructs a FieldMask from the passed field numbers.

Exceptions

IllegalArgumentException if any of the fields are invalid for the message.

Definition at line 158 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromJsonString() [1/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromJsonString ( String value )

inlinestatic

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

Definition at line 168 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromJsonString() [2/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromJsonString ( String value )

inlinestatic

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

Definition at line 192 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromString() [1/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromString	(	Class<? extends Message >	type,
		String	value
	)

inlinestatic

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

Exceptions

IllegalArgumentException if any of the field path is invalid.

Definition at line 94 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromString() [2/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromString	(	Class<? extends Message >	type,
		String	value
	)

inlinestatic

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

Exceptions

IllegalArgumentException if any of the field path is invalid.

Definition at line 96 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromString() [3/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromString ( String value )

inlinestatic

Parses from a string to a FieldMask.

Definition at line 84 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromString() [4/4]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromString ( String value )

inlinestatic

Parses from a string to a FieldMask.

Definition at line 86 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromStringList() [1/5]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromStringList	(	Class<? extends Message >	type,
		Iterable< String >	paths
	)

inlinestatic

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

Exceptions

IllegalArgumentException if any of the field path is not valid.

Definition at line 105 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromStringList() [2/5]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromStringList	(	Class<? extends Message >	type,
		Iterable< String >	paths
	)

inlinestatic

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

Exceptions

IllegalArgumentException if any of the field path is not valid.

Definition at line 107 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromStringList() [3/5]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromStringList	(	Descriptor	descriptor,
		Iterable< String >	paths
	)

inlinestatic

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

Exceptions

IllegalArgumentException if any of the field path is not valid.

Definition at line 116 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromStringList() [4/5]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromStringList ( Iterable< String > paths )

inlinestatic

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

Definition at line 124 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ fromStringList() [5/5]

static FieldMask com.google.protobuf.util.FieldMaskUtil.fromStringList	(	Optional< Descriptor >	descriptor,
		Iterable< String >	paths
	)

inlinestaticprivate

Definition at line 128 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ intersection() [1/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.intersection	(	FieldMask	mask1,
		FieldMask	mask2
	)

inlinestatic

Calculates the intersection of two FieldMasks.

Definition at line 259 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ intersection() [2/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.intersection	(	FieldMask	mask1,
		FieldMask	mask2
	)

inlinestatic

Calculates the intersection of two FieldMasks.

Definition at line 297 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [1/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	@Nullable Descriptor	descriptor,
		String	path
	)

inlinestatic

Checks whether paths in a given fields mask are valid.

Definition at line 235 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [2/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Class<? extends Message >	type,
		FieldMask	fieldMask
	)

inlinestatic

Checks whether paths in a given fields mask are valid.

Definition at line 183 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [3/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Class<? extends Message >	type,
		FieldMask	fieldMask
	)

inlinestatic

Checks whether paths in a given fields mask are valid.

Definition at line 207 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [4/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Class<? extends Message >	type,
		String	path
	)

inlinestatic

Checks whether a given field path is valid.

Definition at line 204 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [5/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Class<? extends Message >	type,
		String	path
	)

inlinestatic

Checks whether a given field path is valid.

Definition at line 228 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [6/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Descriptor	descriptor,
		FieldMask	fieldMask
	)

inlinestatic

Checks whether paths in a given fields mask are valid.

Definition at line 192 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [7/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Descriptor	descriptor,
		FieldMask	fieldMask
	)

inlinestatic

Checks whether paths in a given fields mask are valid.

Definition at line 216 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ isValid() [8/8]

static boolean com.google.protobuf.util.FieldMaskUtil.isValid	(	Descriptor	descriptor,
		String	path
	)

inlinestatic

Checks whether paths in a given fields mask are valid.

Definition at line 213 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ merge() [1/4]

static void com.google.protobuf.util.FieldMaskUtil.merge	(	FieldMask	mask,
		Message	source,
		Message.Builder	destination
	)

inlinestatic

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

Definition at line 359 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ merge() [2/4]

static void com.google.protobuf.util.FieldMaskUtil.merge	(	FieldMask	mask,
		Message	source,
		Message.Builder	destination
	)

inlinestatic

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

Definition at line 397 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ merge() [3/4]

static void com.google.protobuf.util.FieldMaskUtil.merge	(	FieldMask	mask,
		Message	source,
		Message.Builder	destination,
		MergeOptions	options
	)

inlinestatic

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.

Definition at line 351 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ merge() [4/4]

static void com.google.protobuf.util.FieldMaskUtil.merge	(	FieldMask	mask,
		Message	source,
		Message.Builder	destination,
		MergeOptions	options
	)

inlinestatic

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.

Definition at line 389 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ normalize() [1/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.normalize ( FieldMask mask )

inlinestatic

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.

Definition at line 240 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ normalize() [2/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.normalize ( FieldMask mask )

inlinestatic

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.

Definition at line 262 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ subtract()

static FieldMask com.google.protobuf.util.FieldMaskUtil.subtract	(	FieldMask	firstMask,
		FieldMask	secondMask,
		FieldMask...	otherMasks
	)

inlinestatic

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".

Definition at line 285 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ toJsonString() [1/2]

static String com.google.protobuf.util.FieldMaskUtil.toJsonString ( FieldMask fieldMask )

inlinestatic

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.

Definition at line 153 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ toJsonString() [2/2]

static String com.google.protobuf.util.FieldMaskUtil.toJsonString ( FieldMask fieldMask )

inlinestatic

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.

Definition at line 177 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ toString() [1/2]

static String com.google.protobuf.util.FieldMaskUtil.toString ( FieldMask fieldMask )

inlinestatic

Converts a FieldMask to a string.

Definition at line 62 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ toString() [2/2]

static String com.google.protobuf.util.FieldMaskUtil.toString ( FieldMask fieldMask )

inlinestatic

Converts a FieldMask to a string.

Definition at line 64 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ trim()

static <P extends Message> P com.google.protobuf.util.FieldMaskUtil.trim	(	FieldMask	mask,
		P	source
	)

inlinestatic

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

Definition at line 405 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ union() [1/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.union	(	FieldMask	firstMask,
		FieldMask	secondMask,
		FieldMask...	otherMasks
	)

inlinestatic

Creates a union of two or more FieldMasks.

Definition at line 247 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ union() [2/2]

static FieldMask com.google.protobuf.util.FieldMaskUtil.union	(	FieldMask	firstMask,
		FieldMask	secondMask,
		FieldMask...	otherMasks
	)

inlinestatic

Creates a union of two or more FieldMasks.

Definition at line 269 of file protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

Member Data Documentation

◆ FIELD_PATH_SEPARATOR

static final String com.google.protobuf.util.FieldMaskUtil.FIELD_PATH_SEPARATOR = ","

staticprivate

Definition at line 53 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ FIELD_PATH_SEPARATOR_REGEX

static final String com.google.protobuf.util.FieldMaskUtil.FIELD_PATH_SEPARATOR_REGEX = ","

staticprivate

Definition at line 54 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

◆ FIELD_SEPARATOR_REGEX

static final String com.google.protobuf.util.FieldMaskUtil.FIELD_SEPARATOR_REGEX = "\\."

staticprivate

Definition at line 55 of file bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java.

The documentation for this class was generated from the following file:

bloaty/third_party/protobuf/java/util/src/main/java/com/google/protobuf/util/FieldMaskUtil.java

Classes

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FieldMaskUtil() [1/2]

◆ FieldMaskUtil() [2/2]

Member Function Documentation

◆ fromFieldNumbers() [1/4]

◆ fromFieldNumbers() [2/4]

◆ fromFieldNumbers() [3/4]

◆ fromFieldNumbers() [4/4]

◆ fromJsonString() [1/2]

◆ fromJsonString() [2/2]

◆ fromString() [1/4]

◆ fromString() [2/4]

◆ fromString() [3/4]

◆ fromString() [4/4]

◆ fromStringList() [1/5]

◆ fromStringList() [2/5]

◆ fromStringList() [3/5]

◆ fromStringList() [4/5]

◆ fromStringList() [5/5]

◆ intersection() [1/2]

◆ intersection() [2/2]

◆ isValid() [1/8]

◆ isValid() [2/8]

◆ isValid() [3/8]

◆ isValid() [4/8]

◆ isValid() [5/8]

◆ isValid() [6/8]

◆ isValid() [7/8]

◆ isValid() [8/8]

◆ merge() [1/4]

◆ merge() [2/4]

◆ merge() [3/4]

◆ merge() [4/4]

◆ normalize() [1/2]

◆ normalize() [2/2]

◆ subtract()

◆ toJsonString() [1/2]

◆ toJsonString() [2/2]

◆ toString() [1/2]

◆ toString() [2/2]

◆ trim()

◆ union() [1/2]

◆ union() [2/2]

Member Data Documentation

◆ FIELD_PATH_SEPARATOR

◆ FIELD_PATH_SEPARATOR_REGEX

◆ FIELD_SEPARATOR_REGEX