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.api.asn1;
21  
22  
23  import java.nio.ByteBuffer;
24  
25  
26  /**
27   * An abstract class which implements basic TLV operations.
28   * 
29   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
30   */
31  public interface Asn1Object
32  {
33      /**
34       * Compute the object length, which is the sum of all inner length.
35       * 
36       * @return The object's computed length
37       */
38      int computeLength();
39  
40  
41      /**
42       * Encode the object to a PDU.
43       * 
44       * @param buffer The buffer where to put the PDU
45       * @return The encoded PDU.
46       * @throws EncoderException if the buffer can't be encoded
47       */
48      ByteBuffer encode( ByteBuffer buffer ) throws EncoderException;
49  }