# Class FieldMaskUtil (3.19.4)

    public final class FieldMaskUtil

Utility helper functions to work with [com.google.protobuf.FieldMask](https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask).

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> FieldMaskUtil

## Inherited Members

[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## 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** ||
|---|---|
| **Name** | **Description** |
| `mask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `source` | `P` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `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** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html<? extends com.google.protobuf.Message>` |
| `fieldNumbers` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html<? extends com.google.protobuf.Message>` |
| `fieldNumbers` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html<https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html<? extends com.google.protobuf.Message>` |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |   |

### fromString(String value)

    public static FieldMask fromString(String value)

Parses from a string to a FieldMask.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `descriptor` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor` |
| `paths` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html<? extends com.google.protobuf.Message>` |
| `paths` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `paths` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |   |

### intersection(FieldMask mask1, FieldMask mask2)

    public static FieldMask intersection(FieldMask mask1, FieldMask mask2)

Calculates the intersection of two FieldMasks.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `mask1` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `mask2` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `descriptor` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor` |
| `fieldMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** ||
|---|---|
| **Name** | **Description** |
| `descriptor` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Descriptors.Descriptor` |
| `path` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html<? extends com.google.protobuf.Message>` |
| `fieldMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** ||
|---|---|
| **Name** | **Description** |
| `type` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html<? extends com.google.protobuf.Message>` |
| `path` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### 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** ||
|---|---|
| **Name** | **Description** |
| `mask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `source` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Message` |
| `destination` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Message.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** ||
|---|---|
| **Name** | **Description** |
| `mask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `source` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Message` |
| `destination` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.Message.Builder` |
| `options` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.util.FieldMaskUtil.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** ||
|---|---|
| **Name** | **Description** |
| `mask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `firstMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `secondMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `otherMasks` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.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** ||
|---|---|
| **Name** | **Description** |
| `fieldMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### toString(FieldMask fieldMask)

    public static String toString(FieldMask fieldMask)

Converts a FieldMask to a string.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `fieldMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### 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** ||
|---|---|
| **Name** | **Description** |
| `firstMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `secondMask` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |
| `otherMasks` | `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.FieldMask` |   |