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.api.dsmlv2.request;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.i18n.I18n;
25  
26  
27  /**
28   * Not Filter Object to store the Not filter.
29   * 
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public class NotFilter extends ConnectorFilter
33  {
34      /**
35       * Subclass the addFilterMethod, as this is specific for a NotFilter (we
36       * cannot have more than one elements).
37       * 
38       * @param filter The Filter to add
39       */
40      @Override
41      public void addFilter( Filter filter ) throws DecoderException
42      {
43          if ( filterSet != null )
44          {
45              throw new DecoderException( I18n.err( I18n.ERR_05501_MORE_THAN_ONE_FILTER_FOR_NOT_FILTER ) );
46          }
47  
48          super.addFilter( filter );
49      }
50  
51  
52      /**
53       * Get the NotFilter
54       * 
55       * @return Returns the notFilter.
56       */
57      public Filter getNotFilter()
58      {
59          return filterSet.get( 0 );
60      }
61  
62  
63      /**
64       * Set the NotFilter
65       * 
66       * @param notFilter The notFilter to set.
67       * @throws DecoderException If the filter is invalid
68       */
69      public void setNotFilter( Filter notFilter ) throws DecoderException
70      {
71          if ( filterSet != null )
72          {
73              throw new DecoderException( I18n.err( I18n.ERR_05501_MORE_THAN_ONE_FILTER_FOR_NOT_FILTER ) );
74          }
75  
76          super.addFilter( notFilter );
77      }
78  
79  
80      /**
81       * Return a string compliant with RFC 2254 representing a NOT filter
82       * 
83       * @return The NOT filter string
84       */
85      @Override
86      public String toString()
87      {
88          StringBuilder sb = new StringBuilder();
89  
90          sb.append( '!' ).append( super.toString() );
91  
92          return sb.toString();
93      }
94  }