001 /* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020 package org.apache.directory.shared.asn1; 021 022 023 import java.nio.ByteBuffer; 024 025 import org.apache.directory.shared.asn1.codec.DecoderException; 026 import org.apache.directory.shared.asn1.codec.EncoderException; 027 028 029 /** 030 * An abstract class which implements basic TLV operations. 031 * 032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 033 * @version $Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sat, 07 Jun 2008) $ 034 */ 035 public interface Asn1Object 036 { 037 /** 038 * Get the current object length, which is the sum of all inner length 039 * already decoded. 040 * 041 * @return The current object's length 042 */ 043 int getCurrentLength(); 044 045 046 /** 047 * Compute the object length, which is the sum of all inner length. 048 * 049 * @return The object's computed length 050 */ 051 int computeLength(); 052 053 054 /** 055 * Encode the object to a PDU. 056 * 057 * @param buffer The buffer where to put the PDU 058 * @return The PDU. 059 * @throws EncoderException if the buffer can't be encoded 060 */ 061 ByteBuffer encode( ByteBuffer buffer ) throws EncoderException; 062 063 064 /** 065 * Get the expected object length. 066 * 067 * @return The expected object's length 068 */ 069 int getExpectedLength(); 070 071 072 /** 073 * Add a length to the object 074 * 075 * @param length 076 * The length to add. 077 * @throws DecoderException 078 * Thrown if the current length exceed the expected length 079 */ 080 void addLength( int length ) throws DecoderException; 081 082 083 /** 084 * Set the expected length 085 * 086 * @param expectedLength 087 * The expectedLength to set. 088 */ 089 void setExpectedLength( int expectedLength ); 090 091 092 /** 093 * Set the current length 094 * 095 * @param currentLength 096 * The currentLength to set. 097 */ 098 void setCurrentLength( int currentLength ); 099 100 101 /** 102 * Get the parent 103 * 104 * @return Returns the parent. 105 */ 106 Asn1Object getParent(); 107 }