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 */
020package org.apache.directory.shared.asn1.ber.tlv;
021
022
023import org.apache.directory.shared.i18n.I18n;
024import org.slf4j.Logger;
025import org.slf4j.LoggerFactory;
026
027
028/**
029 * Parse and decode a Boolean value.
030 *
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public final class BooleanDecoder
034{
035    /** The logger */
036    private static final Logger LOG = LoggerFactory.getLogger( BooleanDecoder.class );
037
038
039    /**
040     * Parse a byte buffer and send back a booelan.
041     *
042     * @param value The byte buffer to parse
043     * @return A boolean.
044     * @throws BooleanDecoderException Thrown if the byte stream does not contains a boolean
045     */
046    public static boolean parse( Value value ) throws BooleanDecoderException
047    {
048        byte[] bytes = value.getData();
049
050        if ( ( bytes == null ) || ( bytes.length == 0 ) )
051        {
052            throw new BooleanDecoderException( I18n.err( I18n.ERR_00034_0_BYTES_LONG_BOOLEAN ) );
053        }
054
055        if ( bytes.length != 1 )
056        {
057            throw new BooleanDecoderException( I18n.err( I18n.ERR_00035_N_BYTES_LONG_BOOLEAN ) );
058        }
059
060        if ( ( bytes[0] != 0 ) && ( bytes[0] != ( byte ) 0xFF ) )
061        {
062            LOG.warn( "A boolean must be encoded with a 0x00 or a 0xFF value" );
063        }
064
065        return bytes[0] != 0;
066    }
067}