Class RowFilter

    • Method Detail

      • hasAnd

        public final boolean hasAnd()
        For responses, this returns true if the service returned a value for the And property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • and

        public final List<RowFilter> and()

        The 'and' clause of the row filter.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAnd() method.

        Returns:
        The 'and' clause of the row filter.
      • expression

        public final RowFilterExpression expression()

        The expression of the row filter.

        Returns:
        The expression of the row filter.
      • hasOr

        public final boolean hasOr()
        For responses, this returns true if the service returned a value for the Or property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • or

        public final List<RowFilter> or()

        The 'or' clause of the row filter.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOr() method.

        Returns:
        The 'or' clause of the row filter.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)
      • fromAnd

        public static RowFilter fromAnd​(List<RowFilter> and)
        Create an instance of this class with and() initialized to the given value.

        The 'and' clause of the row filter.

        Parameters:
        and - The 'and' clause of the row filter.
      • fromExpression

        public static RowFilter fromExpression​(RowFilterExpression expression)
        Create an instance of this class with expression() initialized to the given value.

        The expression of the row filter.

        Parameters:
        expression - The expression of the row filter.
      • fromExpression

        public static RowFilter fromExpression​(Consumer<RowFilterExpression.Builder> expression)
        Create an instance of this class with expression() initialized to the given value.

        The expression of the row filter.

        Parameters:
        expression - The expression of the row filter.
      • fromOr

        public static RowFilter fromOr​(List<RowFilter> or)
        Create an instance of this class with or() initialized to the given value.

        The 'or' clause of the row filter.

        Parameters:
        or - The 'or' clause of the row filter.
      • type

        public RowFilter.Type type()
        Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be RowFilter.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be RowFilter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.