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  
21  package org.apache.directory.api.dsmlv2.response;
22  
23  
24  import org.apache.directory.api.dsmlv2.DsmlLiterals;
25  import org.apache.directory.api.ldap.codec.api.LdapApiService;
26  import org.apache.directory.api.ldap.model.message.CompareResponse;
27  import org.apache.directory.api.ldap.model.message.CompareResponseImpl;
28  import org.apache.directory.api.ldap.model.message.MessageTypeEnum;
29  import org.dom4j.Element;
30  import org.dom4j.tree.DefaultElement;
31  
32  
33  /**
34   * DSML Decorator for CompareResponse
35   *
36   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37   */
38  public class CompareResponseDsml extends AbstractResultResponseDsml<CompareResponse> implements CompareResponse
39  {
40      /**
41       * Creates a new getDecoratedMessage() of CompareResponseDsml.
42       * 
43       * @param codec The LDAP Service to use
44       */
45      public CompareResponseDsml( LdapApiService codec )
46      {
47          super( codec, new CompareResponseImpl() );
48      }
49  
50  
51      /**
52       * Creates a new getDecoratedMessage() of CompareResponseDsml.
53       *
54       * @param codec The LDAP Service to use
55       * @param ldapMessage the message to decorate
56       */
57      public CompareResponseDsml( LdapApiService codec, CompareResponse ldapMessage )
58      {
59          super( codec, ldapMessage );
60      }
61  
62  
63      /**
64       * {@inheritDoc}
65       */
66      @Override
67      public MessageTypeEnum getType()
68      {
69          return getDecorated().getType();
70      }
71  
72  
73      /**
74       * {@inheritDoc}
75       */
76      @Override
77      public Element toDsml( Element root )
78      {
79          Element element;
80  
81          if ( root != null )
82          {
83              element = root.addElement( DsmlLiterals.COMPARE_RESPONSE );
84          }
85          else
86          {
87              element = new DefaultElement( DsmlLiterals.COMPARE_RESPONSE );
88          }
89  
90          LdapResultDsml ldapResultDsml = new LdapResultDsml( getCodecService(),
91              getDecorated().getLdapResult(), getDecorated() );
92          ldapResultDsml.toDsml( element );
93          return element;
94      }
95  
96  
97      /**
98       * {@inheritDoc}
99       */
100     @Override
101     public boolean isTrue()
102     {
103         return getDecorated().isTrue();
104     }
105 }