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    
021    package org.apache.directory.server.dns.io.decoder;
022    
023    
024    import java.io.IOException;
025    import java.util.Map;
026    
027    import org.apache.mina.core.buffer.IoBuffer;
028    
029    
030    /**
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Rev$, $Date$
033     */
034    public interface RecordDecoder
035    {
036        /**
037         * Decodes the given length of resource record data into attributes.  The
038         * type and number of attributes depends on the type of the resource record.
039         *
040         * @param byteBuffer
041         * @param length
042         * @return The map of attributes.
043         * @throws IOException
044         */
045        public Map<String, Object> decode( IoBuffer byteBuffer, short length ) throws IOException;
046    }