Class CompareFilter

java.lang.Object
org.springframework.ldap.filter.AbstractFilter
org.springframework.ldap.filter.CompareFilter
All Implemented Interfaces:
Filter
Direct Known Subclasses:
EqualsFilter, GreaterThanOrEqualsFilter, LessThanOrEqualsFilter, ProximityFilter
public abstract class CompareFilter extends AbstractFilter
Abstract superclass for filters that compare values.

  • Constructor Details

    • CompareFilter

      @Deprecated(since="3.3") public CompareFilter(String attribute, String value)
      Deprecated.
      please use the protected constructor instead

    • CompareFilter

      @Deprecated(since="3.3") public CompareFilter(String attribute, int value)
      Deprecated.
      please use the protected constructor instead
      Convenience constructor for int values.
      Parameters:
      attribute - Name of attribute in filter.
      value - The value of the attribute in the filter.

    • CompareFilter

      protected CompareFilter(String attribute, String operator, String value, String encodedValue)
      Construct a filter, specifying the comparison operator as well as the already-encoded value
      Parameters:
      attribute - the attribute name
      operator - the comparison operator; for example, =, ~=
      encodedValue - the already-encoded value
      Since:
      3.3

  • Method Details

    • encodeValue

      @Deprecated(forRemoval=true, since="3.3") protected String encodeValue(String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      please provide the encoded value in the constructor
      Override to perform special encoding in subclass.
      Parameters:
      value - the value to encode.
      Returns:
      properly escaped value.

    • encode

      public StringBuffer encode(StringBuffer buff)
      Description copied from interface: Filter
      Encodes the filter to a StringBuffer.
      Parameters:
      buff - The StringBuffer to encode the filter to
      Returns:
      The same StringBuffer as was given

    • equals

      public boolean equals(Object o)
      Description copied from interface: Filter
      All filters must implement equals.
      Specified by:
      equals in interface Filter
      Overrides:
      equals in class Object
      Parameters:
      o -
      Returns:
      true if the objects are equal.

    • hashCode

      public int hashCode()
      Description copied from interface: Filter
      All filters must implement hashCode.
      Specified by:
      hashCode in interface Filter
      Overrides:
      hashCode in class Object
      Returns:
      the hash code according to the contract in Object.hashCode()

    • getCompareString

      @Deprecated(forRemoval=true, since="3.3") protected String getCompareString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      please specify the operator in the constructor
      Implement this method in subclass to return a String representing the operator. The EqualsFilter.getCompareString() would for example return an equals sign, "=".
      Returns:
      the String to use as operator in the comparison for the specific subclass.