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.util;
021
022
023 import org.apache.directory.shared.asn1.ber.tlv.Value;
024 import org.slf4j.Logger;
025 import 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 * @version $Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sam, 07 jui 2008) $
033 */
034 public class BooleanDecoder
035 {
036 /** The logger */
037 private static final Logger log = LoggerFactory.getLogger( BooleanDecoder.class );
038
039
040 // ~ Methods
041 // ------------------------------------------------------------------------------------
042
043 /**
044 * Parse a byte buffer and send back a booelan.
045 *
046 * @param value
047 * The byte buffer to parse
048 * @return A boolean.
049 * @throws BooleanDecoderException
050 * Thrown if the byte stream does not contains a boolean
051 */
052 public static boolean parse( Value value ) throws BooleanDecoderException
053 {
054 byte[] bytes = value.getData();
055
056 if ( ( bytes == null ) || ( bytes.length == 0 ) )
057 {
058 throw new BooleanDecoderException( "The value is 0 byte long. This is not allowed for a boolean" );
059 }
060
061 if ( bytes.length != 1 )
062 {
063 throw new BooleanDecoderException( "The value is not 1 byte long. This is not allowed for a boolean" );
064 }
065
066 if ( ( bytes[0] != 0 ) && ( bytes[0] != ( byte ) 0xFF ) )
067 {
068 log.warn( "A boolean must be encoded with a 0x00 or a 0xFF value" );
069 }
070
071 return bytes[0] != 0;
072 }
073 }