Class SubstringFilter

  • All Implemented Interfaces:
    Filter

    public class SubstringFilter
    extends java.lang.Object
    implements Filter
    Substring search filter component defined as:
     (attributeDescription=attributeValueWithWildCard)
     
    Author:
    Middleware Services
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SubstringFilter.Substrings
      Type of substring match.
      • Nested classes/interfaces inherited from interface org.ldaptive.filter.Filter

        Filter.Type
    • Constructor Summary

      Constructors 
      Constructor Description
      SubstringFilter​(java.lang.String name, byte[] startsWith, byte[] endsWith, byte[]... contains)
      Creates a new substring filter.
      SubstringFilter​(java.lang.String name, java.lang.String startsWith, java.lang.String endsWith, java.lang.String... contains)
      Creates a new substring filter.
    • Constructor Detail

      • SubstringFilter

        public SubstringFilter​(java.lang.String name,
                               java.lang.String startsWith,
                               java.lang.String endsWith,
                               java.lang.String... contains)
        Creates a new substring filter.
        Parameters:
        name - attribute description
        startsWith - substring initial
        endsWith - substring final
        contains - substring any
      • SubstringFilter

        public SubstringFilter​(java.lang.String name,
                               byte[] startsWith,
                               byte[] endsWith,
                               byte[]... contains)
        Creates a new substring filter.
        Parameters:
        name - attribute description
        startsWith - substring initial
        endsWith - substring final
        contains - substring any
    • Method Detail

      • getAttributeDesc

        public java.lang.String getAttributeDesc()
        Returns the attribute description.
        Returns:
        attribute description
      • getSubInitial

        public byte[] getSubInitial()
        Returns the initial substring assertion.
        Returns:
        initial substring assertion
      • getSubAny

        public byte[][] getSubAny()
        Returns the any substring assertion.
        Returns:
        any substring assertion
      • getSubFinal

        public byte[] getSubFinal()
        Returns the final substring assertion.
        Returns:
        final substring assertion
      • getEncoder

        public DEREncoder getEncoder()
        Description copied from interface: Filter
        Returns the encoder for this filter.
        Specified by:
        getEncoder in interface Filter
        Returns:
        DER encoder
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object