/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1999 Netscape Communications Corporation.  All Rights
 * Reserved.
 */
package netscape.ldap.ber.stream;

import java.util.*;
import java.io.*;

/**
 * This class is for the NumericString type.
 *
 * <pre>
 * ENCODING RULE:
 *   Primitive Definite length.
 *   tag = 0x12
 *   length = (short or long form)
 *   one or more contents octets
 * </pre>
 *
 * @version 1.0
 * @seeAlso CCITT X.209
 */
public class BERNumericString extends BERCharacterString {

    /**
     * Constructs a numeric string element from a string
     * @param buffer string with value of element
     */
    public BERNumericString(String string) {
        m_value = string;
    }

    /**
     * Constructs a numeric string element from a byte array
     * @param buffer buffer
     */
    public BERNumericString(byte[] buffer) {
        super(buffer);
    }

    /**
     * Constructs a numeric string element from an input stream
     * (for constructed encoding)
     * @param stream source
     * @param bytes_read array of 1 int, incremented by number of bytes read.
     * @exception IOException failed to construct
     */
    public BERNumericString(BERTagDecoder decoder, InputStream stream,
                          int[] bytes_read) throws IOException {
        super(decoder,stream,bytes_read);
    }

    /**
     * Constructs a numericstring element from an input stream
     * (for primitive encoding)
     * @param stream input stream
     * @param bytes_read array of 1 int, incremented by number of bytes read.
     * @exception IOException failed to construct
     */
    public BERNumericString(InputStream stream, int[] bytes_read)
        throws IOException {
        super(stream,bytes_read);
    }

    /**
     * Gets the element type.
     * @return element type
     */
    public int getType() {
        return BERElement.NUMERICSTRING;
    }

    /**
     * Gets the string representation. Note that currently prints out
     * values in decimal form.
     * @return string representation of tag
     */
    public String toString() {
        if (m_value == null)
            return "NumericString (null)";
        else
            return "NumericString {" + m_value + "}";
    }
}
