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.api.ldap.codec.api;
21
22
23 import java.nio.ByteBuffer;
24
25 import org.apache.directory.api.asn1.EncoderException;
26
27
28 /**
29 * The codec uses this interface to add additional information to LDAP Model
30 * objects during encoding and decoding,
31 *
32 * @param <E> The element to decorate
33 *
34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
35 */
36 public interface Decorator<E>
37 {
38 /**
39 * Gets the object being decorated by this IDecorator.
40 *
41 * @return The decorated object
42 */
43 E getDecorated();
44
45
46 /**
47 * Compute the object length, which is the sum of all inner length.
48 *
49 * @return The object's computed length
50 */
51 int computeLength();
52
53
54 /**
55 * Encode the object to a PDU.
56 *
57 * @param buffer The buffer where to put the PDU
58 * @return The PDU.
59 * @throws EncoderException if the buffer can't be encoded
60 */
61 ByteBuffer encode( ByteBuffer buffer ) throws EncoderException;
62
63
64 /**
65 * Gets the codec service responsible for managing the encoding and
66 * decoding of the decorated objects.
67 *
68 * @return the codec service
69 */
70 LdapApiService getCodecService();
71 }