View Javadoc
1   /*
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *   or more contributor license agreements.  See the NOTICE file
4    *   distributed with this work for additional information
5    *   regarding copyright ownership.  The ASF licenses this file
6    *   to you under the Apache License, Version 2.0 (the
7    *   "License"); you may not use this file except in compliance
8    *   with the License.  You may obtain a copy of the License at
9    *
10   *     https://www.apache.org/licenses/LICENSE-2.0
11   *
12   *   Unless required by applicable law or agreed to in writing,
13   *   software distributed under the License is distributed on an
14   *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *   KIND, either express or implied.  See the License for the
16   *   specific language governing permissions and limitations
17   *   under the License.
18   *
19   */
20  package org.apache.directory.ldap.client.api.search;
21  
22  
23  /**
24   *
25   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
26   */
27  public class MatchingRuleAssertionFilterBuilder extends FilterBuilder
28  {
29      /**
30       * Creates a new instance of MatchingRuleAssertionFilterBuilder.
31       *
32       * @param attribute The attribute to test
33       * @param value The value to test for
34       */
35      /* No qualifier*/ MatchingRuleAssertionFilterBuilder( String attribute, String value )
36      {
37          super( MatchingRuleAssertionFilter.extensible( attribute, value ) );
38      }
39      
40      
41      /**
42       * Sets the matching rule to use.  Can be either a name or an OID string.
43       *
44       * @param matchingRule The matching rule to use
45       * @return This filter
46       */
47      public MatchingRuleAssertionFilterBuilder setMatchingRule( String matchingRule )
48      {
49          ( ( MatchingRuleAssertionFilter ) filter ).setMatchingRule( matchingRule );
50          return this;
51      }
52      
53      
54      /**
55       * If set, the dn attributes will be included in the matching.
56       *
57       * @return This filter
58       */
59      public MatchingRuleAssertionFilterBuilder useDnAttributes()
60      {
61          ( ( MatchingRuleAssertionFilter ) filter ).useDnAttributes();
62          return this;
63      }
64  }