001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2006-2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.api;
028    
029    
030    
031    import org.opends.server.types.AttributeValue;
032    import org.opends.server.types.DirectoryException;
033    
034    
035    
036    /**
037     * A factory interface for decoding attribute values into objects.
038     *
039     * @param  <T>  Decode the attribute value to an object of this type.
040     */
041    @org.opends.server.types.PublicAPI(
042         stability=org.opends.server.types.StabilityLevel.VOLATILE,
043         mayInstantiate=false,
044         mayExtend=true,
045         mayInvoke=true)
046    public interface AttributeValueDecoder<T>
047    {
048      /**
049       * Decode the specified attribute value to an object of type T.
050       *
051       * @param value
052       *          The attribute value.
053       * @return The decoded attribute value.
054       * @throws DirectoryException
055       *           If the value could not be decoded successfully.
056       */
057      T decode(AttributeValue value) throws DirectoryException;
058    }
059