Class FieldMaskUtil

java.lang.Object
com.google.protobuf.util.FieldMaskUtil
public final class FieldMaskUtil extends Object
Utility helper functions to work with FieldMask.

  • Field Details

  • Constructor Details

    • FieldMaskUtil

      private FieldMaskUtil()

  • Method Details

    • toString

      public static String toString(FieldMask fieldMask)
      Converts a FieldMask to a string.

    • fromString

      public static FieldMask fromString(String value)
      Parses from a string to a FieldMask.

    • fromString

      public static FieldMask fromString(Class<? extends Message> type, String value)
      Parses from a string to a FieldMask and validates all field paths.
      Throws:
      IllegalArgumentException - if any of the field path is invalid.

    • fromStringList

      public static FieldMask fromStringList(Class<? extends Message> type, Iterable<String> paths)
      Constructs a FieldMask for a list of field paths in a certain type.
      Throws:
      IllegalArgumentException - if any of the field path is not valid

    • fromStringList

      public static FieldMask fromStringList(Descriptors.Descriptor descriptor, Iterable<String> paths)
      Constructs a FieldMask for a list of field paths in a certain type.
      Throws:
      IllegalArgumentException - if any of the field path is not valid.

    • fromStringList

      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.

    • fromStringList

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

    • fromFieldNumbers

      public static FieldMask fromFieldNumbers(Class<? extends Message> type, int... fieldNumbers)
      Constructs a FieldMask from the passed field numbers.
      Throws:
      IllegalArgumentException - if any of the fields are invalid for the message.

    • fromFieldNumbers

      public static FieldMask fromFieldNumbers(Class<? extends Message> type, Iterable<Integer> fieldNumbers)
      Constructs a FieldMask from the passed field numbers.
      Throws:
      IllegalArgumentException - if any of the fields are invalid for the message.

    • lowerUnderscoreToLowerCamel

      private static String lowerUnderscoreToLowerCamel(String str)
      Converts a lower_underscore to lowerCamelCase style.

    • lowerCamelToLowerUnderscore

      private static String lowerCamelToLowerUnderscore(String str)
      Converts a lowerCamelCase string to lower_underscore style.

    • toJsonString

      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.

    • fromJsonString

      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.

    • isValid

      public static boolean isValid(Class<? extends Message> type, FieldMask fieldMask)
      Checks whether paths in a given fields mask are valid.

    • isValid

      public static boolean isValid(Descriptors.Descriptor descriptor, FieldMask fieldMask)
      Checks whether paths in a given fields mask are valid.

    • isValid

      public static boolean isValid(Class<? extends Message> type, String path)
      Checks whether a given field path is valid.

    • isValid

      public static boolean isValid(@Nullable Descriptors.Descriptor descriptor, String path)
      Checks whether paths in a given fields mask are valid.

    • normalize

      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.

    • union

      public static FieldMask union(FieldMask firstMask, FieldMask secondMask, FieldMask... otherMasks)
      Creates a union of two or more FieldMasks.

    • subtract

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

    • intersection

      public static FieldMask intersection(FieldMask mask1, FieldMask mask2)
      Calculates the intersection of two FieldMasks.

    • merge

      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.

    • merge

      public static void merge(FieldMask mask, Message source, Message.Builder destination)
      Merges fields specified by a FieldMask from one message to another.

    • trim

      public static <P extends Message> P trim(FieldMask mask, P source, FieldMaskUtil.TrimOptions options)
      Returns the result of keeping only the masked fields of the given proto with the specified trim options.

      Note that the behavior with the default FieldMaskUtil.TrimOptions is for unset primitive fields indicated in the field mask to be explicitly set to their default values. Use new TrimOptions().setRetainPrimitiveFieldUnsetState(true) to retain the unset state of primitive fields.

    • trim

      public static <P extends Message> P trim(FieldMask mask, P source)
      Returns the result of keeping only the masked fields of the given proto.

      This method is equivalent to trim(FieldMask, Message, TrimOptions) with default FieldMaskUtil.TrimOptions.

      Note that unset primitive fields indicated in the field mask will be explicitly set to their default values.