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   *     http://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   * This class is used to handle the Present filter (ie, attr =* )
25   *
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   */
28  /* No qualifier*/final class AttributeDescriptionFilter extends AbstractFilter
29  {
30      /** The attribute that must be prersent */
31      private String attribute;
32  
33  
34      /**
35       * Creates a new instance of AttributeDescription filter.
36       */
37      private AttributeDescriptionFilter( String attribute )
38      {
39          this.attribute = attribute;
40      }
41  
42  
43      /**
44       * Creates a new AttributeDescription 
45       *
46       * @param attribute The attribute that must be present
47       * @return The created PresenceFilter instance
48       */
49      public static AttributeDescriptionFilter present( String attribute )
50      {
51          return new AttributeDescriptionFilter( attribute );
52      }
53  
54  
55      /**
56       * {@inheritDoc}
57       */
58      @Override
59      public StringBuilder build( StringBuilder builder )
60      {
61          return builder.append( "(" ).append( attribute ).append( FilterOperator.PRESENT.operator() ).append( ")" );
62      }
63  }