001/*
002 *   Licensed to the Apache Software Foundation (ASF) under one
003 *   or more contributor license agreements.  See the NOTICE file
004 *   distributed with this work for additional information
005 *   regarding copyright ownership.  The ASF licenses this file
006 *   to you under the Apache License, Version 2.0 (the
007 *   "License"); you may not use this file except in compliance
008 *   with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *   Unless required by applicable law or agreed to in writing,
013 *   software distributed under the License is distributed on an
014 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *   KIND, either express or implied.  See the License for the
016 *   specific language governing permissions and limitations
017 *   under the License.
018 *
019 */
020package org.apache.directory.ldap.client.api.search;
021
022
023/**
024 *
025 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
026 */
027public class MatchingRuleAssertionFilterBuilder extends FilterBuilder
028{
029    /**
030     * Creates a new instance of MatchingRuleAssertionFilterBuilder.
031     *
032     * @param attribute The attribute to test
033     * @param value The value to test for
034     */
035    /* No qualifier*/ MatchingRuleAssertionFilterBuilder( String attribute, String value )
036    {
037        super( MatchingRuleAssertionFilter.extensible( attribute, value ) );
038    }
039    
040    
041    /**
042     * Sets the matching rule to use.  Can be either a name or an OID string.
043     *
044     * @param matchingRule The matching rule to use
045     * @return This filter
046     */
047    public MatchingRuleAssertionFilterBuilder setMatchingRule( String matchingRule )
048    {
049        ( ( MatchingRuleAssertionFilter ) filter ).setMatchingRule( matchingRule );
050        return this;
051    }
052    
053    
054    /**
055     * If set, the dn attributes will be included in the matching.
056     *
057     * @return This filter
058     */
059    public MatchingRuleAssertionFilterBuilder useDnAttributes()
060    {
061        ( ( MatchingRuleAssertionFilter ) filter ).useDnAttributes();
062        return this;
063    }
064}