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
21 package org.apache.directory.api.dsmlv2.response;
22
23
24 import org.apache.directory.api.ldap.codec.api.LdapApiService;
25 import org.apache.directory.api.ldap.model.message.CompareResponse;
26 import org.apache.directory.api.ldap.model.message.CompareResponseImpl;
27 import org.apache.directory.api.ldap.model.message.MessageTypeEnum;
28 import org.dom4j.Element;
29 import org.dom4j.tree.DefaultElement;
30
31
32 /**
33 * DSML Decorator for CompareResponse
34 *
35 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36 */
37 public class CompareResponseDsml extends AbstractResultResponseDsml<CompareResponse> implements CompareResponse
38 {
39 private static final String COMPARE_RESPONSE_TAG = "compareResponse";
40
41
42 /**
43 * Creates a new getDecoratedMessage() of CompareResponseDsml.
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 ldapMessage
55 * 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 public MessageTypeEnum getType()
67 {
68 return getDecorated().getType();
69 }
70
71
72 /**
73 * {@inheritDoc}
74 */
75 public Element toDsml( Element root )
76 {
77 Element element = null;
78
79 if ( root != null )
80 {
81 element = root.addElement( COMPARE_RESPONSE_TAG );
82 }
83 else
84 {
85 element = new DefaultElement( COMPARE_RESPONSE_TAG );
86 }
87
88 LdapResultDsml ldapResultDsml = new LdapResultDsml( getCodecService(),
89 getDecorated().getLdapResult(), getDecorated() );
90 ldapResultDsml.toDsml( element );
91 return element;
92 }
93
94
95 /**
96 * {@inheritDoc}
97 */
98 public boolean isTrue()
99 {
100 return getDecorated().isTrue();
101 }
102 }