BEREnumerated.java revision 5c099afa7c9361afc2f4477fec0e3018588d7840
/* -*- 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.1 (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.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
* implied. See the License for the specific language governing
* rights and limitations under the License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1999 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
package com.sun.identity.shared.ldap.ber.stream;
import java.util.*;
import java.io.*;
/**
* This class is for the Enumerated object.
*
* <pre>
* ENCODING RULE:
* Primitive Definite length.
* tag = 0x0a
* length = (short or long form)
* one or more contents octets hold integral value
* value in two's complement
*
* Example: (Enumerated - 1)
* 0A 01 01
* </pre>
*
* @version 1.0
* seeAlso CCITT X.209
* @deprecated As of ForgeRock OpenAM 10.
*/
public class BEREnumerated extends BERIntegral {
/**
* Constructs an enumerated element with a value.
* @param value integral value
*/
public BEREnumerated(int value) {
super(value);
}
/**
* Constructs an enumerated element with the input stream.
* @param stream input stream from which to decode
* @param bytes_read array of 1 int; value incremented by
* number of bytes read from array
* @exception IOException failed to construct
*/
public BEREnumerated(InputStream stream, int[] bytes_read)
throws IOException {
super(stream, bytes_read);
}
/**
* Gets the element type.
* @return element type
*/
public int getType() {
return BERElement.ENUMERATED;
}
/**
* Gets the string representation.
* @return string representation of tag.
*/
public String toString() {
return "Enumerated {" + getValue() + "}";
}
}