protocol-dhcp/src/main/java/org/apache/directory/server/dhcp/options/StringOption.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *
 */

package org.apache.directory.server.dhcp.options;


import java.io.UnsupportedEncodingException;

import org.apache.directory.server.i18n.I18n;


/**
 * The Dynamic Host Configuration Protocol (DHCP) provides a framework for
 * passing configuration information to hosts on a TCP/IP network. Configuration
 * parameters and other control information are carried in tagged data items
 * that are stored in the 'options' field of the DHCP message. The data items
 * themselves are also called "options." 
 * 
 * This abstract base class is for options
 * that carry a string.
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public abstract class StringOption extends DhcpOption
{
    private String string;


    /*
     * @see org.apache.directory.server.dhcp.options.DhcpOption#setData(byte[])
     */
    @Override
    public void setData( byte[] data )
    {
        try
        {
            string = new String( data, "ASCII" );
        }
        catch ( UnsupportedEncodingException e )
        {
            // should not happen
            throw new RuntimeException( I18n.err( I18n.ERR_642 ) );
        }
    }


    /*
     * @see org.apache.directory.server.dhcp.options.DhcpOption#getData()
     */
    @Override
    public byte[] getData()
    {
        if ( null == string )
        {
            return new byte[]
                {};
        }

        try
        {
            return string.getBytes( "ASCII" );
        }
        catch ( UnsupportedEncodingException e )
        {
            // should not happen
            throw new RuntimeException( I18n.err( I18n.ERR_642 ) );
        }
    }


    public String getString()
    {
        return string;
    }


    public void setString( String string )
    {
        this.string = string;
    }
}