com.novell.ldap.asn1.ASN1SequenceOf Maven / Gradle / Ivy

/* **************************************************************************
 * $OpenLDAP$
 *
 * Copyright (C) 1999, 2000, 2001 Novell, Inc. All Rights Reserved.
 *
 * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND
 * TREATIES. USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT
 * TO VERSION 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS
 * AVAILABLE AT HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE"
 * IN THE TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION
 * OF THIS WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP
 * PUBLIC LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT
 * THE PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
 ******************************************************************************/

package com.novell.ldap.asn1;

import java.io.IOException;
import java.io.InputStream;

/**
 * The ASN1SequenceOf class is used to hold an ordered collection
 * of components with identical type.  This class inherits
 * from the ASN1Structured class which already provides
 * functionality to hold multiple ASN1 components.
 */
public class ASN1SequenceOf extends ASN1Structured {

    /**
     * ASN.1 SEQUENCE OF tag definition.
     */
    public static final int TAG = 0x10;

    /**
     * ID is added for Optimization.
     *
     * ID needs only be one Value for every instance,
     * thus we create it only once.
     */
     public static final ASN1Identifier ID =
        new ASN1Identifier(ASN1Identifier.UNIVERSAL, true, TAG);

    /* Constructors for ASN1SequenceOf
     */

    /**
     * Constructs an ASN1SequenceOf object with no actual
     * ASN1Objects in it. Assumes a default size of 5 elements.
     */
    public ASN1SequenceOf()
    {
        super(ID);
        return;
    }


    /**
     * Constructs an ASN1SequenceOf object with the specified
     * number of placeholders for ASN1Objects. However there
     * are no actual ASN1Objects in this SequenceOf object.
     *
     * @param size Specifies the initial size of the collection.
     */
    public ASN1SequenceOf(int size)
    {
        super(ID, size);
        return;
    }


    /**
     * A copy constructor which creates an ASN1SequenceOf from an
     * instance of ASN1Sequence.
     *
     * Since SEQUENCE and SEQUENCE_OF have the same identifier, the decoder
     * will always return a SEQUENCE object when it detects that identifier.
     * In order to take advantage of the ASN1SequenceOf type, we need to be
     * able to construct this object when knowingly receiving an
     * ASN1Sequence.
     */
    public ASN1SequenceOf(ASN1Sequence sequence)
    {
        super(ID, sequence.toArray(), sequence.size());
        return;
    }


    /**
     * Constructs an ASN1SequenceOf object by decoding data from an
     * input stream.
     *
     * @param dec The decoder object to use when decoding the
     * input stream.  Sometimes a developer might want to pass
     * in his/her own decoder object

     *
     * @param in A byte stream that contains the encoded ASN.1
     *
     */
    public ASN1SequenceOf(ASN1Decoder dec, InputStream in, int len)
        throws IOException
    {
        super(ID);
        decodeStructured(dec, in, len);
        return;
    }


    /* ASN1SequenceOf specific methods
     */

    /**
     * Returns a String representation of this ASN1SequenceOf object
     */
    public String toString()
    {
        return super.toString("SEQUENCE OF: { ");
    }
}