Java example source code file (EnumRowStatus.java)

This example Java source code file (EnumRowStatus.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

enumerated, enumrowstatus, hashtable, illegalargumentexception, integer, override, serializable, snmpint, string, util

The EnumRowStatus.java Java example source code

/*
 * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.jmx.snmp;

import java.io.Serializable;
import java.util.Hashtable;


/**
 * This class is an internal class which is used to represent RowStatus
 * codes as defined in RFC 2579.
 *
 * It defines an additional code, <i>unspecified, which is
 * implementation specific, and is used to identify
 * unspecified actions (when for instance the RowStatus variable
 * is not present in the varbind list) or uninitialized values.
 *
 * mibgen does not generate objects of this class but any variable
 * using the RowStatus textual convention can be converted into an
 * object of this class thanks to the
 * <code>EnumRowStatus(Enumerated valueIndex) constructor.
 *
 * <p>This API is a Sun Microsystems internal API  and is subject
 * to change without notice.</b>

 **/

public class EnumRowStatus extends Enumerated implements Serializable {
    private static final long serialVersionUID = 8966519271130162420L;

    /**
     * This value is SNMP Runtime implementation specific, and is used to identify
     * unspecified actions (when for instance the RowStatus variable
     * is not present in the varbind list) or uninitialized values.
     */
    public final static int unspecified   = 0;

    /**
     * This value corresponds to the <i>active RowStatus, as defined in
     * RFC 2579 from SMIv2:
     * <ul>
     * <i>active indicates that the conceptual row is available for
     * use by the managed device;
     * </ul>
     */
    public final static int active        = 1;

    /**
     * This value corresponds to the <i>notInService RowStatus, as
     * defined in RFC 2579 from SMIv2:
     * <ul>
     * <i>notInService indicates that the conceptual
     * row exists in the agent, but is unavailable for use by
     * the managed device; <i>notInService has
     * no implication regarding the internal consistency of
     * the row, availability of resources, or consistency with
     * the current state of the managed device;
     * </ul>
     **/
    public final static int notInService  = 2;

    /**
     * This value corresponds to the <i>notReady RowStatus, as defined
     * in RFC 2579 from SMIv2:
     * <ul>
     * <i>notReady indicates that the conceptual row
     * exists in the agent, but is missing information
     * necessary in order to be available for use by the
     * managed device (i.e., one or more required columns in
     * the conceptual row have not been instantiated);
     * </ul>
     */
    public final static int notReady      = 3;

    /**
     * This value corresponds to the <i>createAndGo RowStatus,
     * as defined in RFC 2579 from SMIv2:
     * <ul>
     * <i>createAndGo is supplied by a management
     * station wishing to create a new instance of a
     * conceptual row and to have its status automatically set
     * to active, making it available for use by the managed
     * device;
     * </ul>
     */
    public final static int createAndGo   = 4;

    /**
     * This value corresponds to the <i>createAndWait RowStatus,
     * as defined in RFC 2579 from SMIv2:
     * <ul>
     * <i>createAndWait is supplied by a management
     * station wishing to create a new instance of a
     * conceptual row (but not make it available for use by
     * the managed device);
     * </ul>
     */
    public final static int createAndWait = 5;

    /**
     * This value corresponds to the <i>destroy RowStatus, as defined in
     * RFC 2579 from SMIv2:
     * <ul>
     * <i>destroy is supplied by a management station
     * wishing to delete all of the instances associated with
     * an existing conceptual row.
     * </ul>
     */
    public final static int destroy       = 6;

    /**
     * Build an <code>EnumRowStatus from an int.
     * @param valueIndex should be either 0 (<i>unspecified), or one of
     *        the values defined in RFC 2579.
     * @exception IllegalArgumentException if the given
     *            <code>valueIndex is not valid.
     **/
    public EnumRowStatus(int valueIndex)
        throws IllegalArgumentException {
        super(valueIndex);
    }

    /**
     * Build an <code>EnumRowStatus from an Enumerated.
     * @param valueIndex should be either 0 (<i>unspecified), or one of
     *        the values defined in RFC 2579.
     * @exception IllegalArgumentException if the given
     *            <code>valueIndex is not valid.
     **/
    public EnumRowStatus(Enumerated valueIndex)
        throws IllegalArgumentException {
        this(valueIndex.intValue());
    }

    /**
     * Build an <code>EnumRowStatus from a long.
     * @param valueIndex should be either 0 (<i>unspecified), or one of
     *        the values defined in RFC 2579.
     * @exception IllegalArgumentException if the given
     *            <code>valueIndex is not valid.
     **/
    public EnumRowStatus(long valueIndex)
        throws IllegalArgumentException {
        this((int)valueIndex);
    }

    /**
     * Build an <code>EnumRowStatus from an Integer.
     * @param valueIndex should be either 0 (<i>unspecified), or one of
     *        the values defined in RFC 2579.
     * @exception IllegalArgumentException if the given
     *            <code>valueIndex is not valid.
     **/
    public EnumRowStatus(Integer valueIndex)
        throws IllegalArgumentException {
        super(valueIndex);
    }

    /**
     * Build an <code>EnumRowStatus from a Long.
     * @param valueIndex should be either 0 (<i>unspecified), or one of
     *        the values defined in RFC 2579.
     * @exception IllegalArgumentException if the given
     *            <code>valueIndex is not valid.
     **/
    public EnumRowStatus(Long valueIndex)
        throws IllegalArgumentException {
        this(valueIndex.longValue());
    }

    /**
     * Build an <code>EnumRowStatus with unspecified value.
     **/
    public EnumRowStatus()
        throws IllegalArgumentException {
        this(unspecified);
    }

    /**
     * Build an <code>EnumRowStatus from a String.
     * @param x should be either "unspecified", or one of
     *        the values defined in RFC 2579 ("active", "notReady", etc...)
     * @exception IllegalArgumentException if the given String
     *            <code>x is not valid.
     **/
    public EnumRowStatus(String x)
        throws IllegalArgumentException {
        super(x);
    }

    /**
     * Build an <code>EnumRowStatus from an SnmpInt.
     * @param valueIndex should be either 0 (<i>unspecified), or one of
     *        the values defined in RFC 2579.
     * @exception IllegalArgumentException if the given
     *            <code>valueIndex is not valid.
     **/
    public EnumRowStatus(SnmpInt valueIndex)
        throws IllegalArgumentException {
        this(valueIndex.intValue());
    }

    /**
     * Build an SnmpValue from this object.
     *
     * @exception IllegalArgumentException if this object holds an
     *            <i>unspecified value.
     * @return an SnmpInt containing this object value.
     **/
    public SnmpInt toSnmpValue()
        throws IllegalArgumentException {
        if (value == unspecified)
            throw new
        IllegalArgumentException("`unspecified' is not a valid SNMP value.");
        return new SnmpInt(value);
    }

    /**
     * Check that the given <code>value is valid.
     *
     * Valid values are:
     * <ul>
unspecified(0)
     *     <li>active(1)
     *     <li>notInService(2)
     *     <li>notReady(3)
     *     <li>createAndGo(4)
     *     <li>createAndWait(5)
     *     <li>destroy(6)
     * </ul>
     *
     **/
    static public boolean isValidValue(int value) {
        if (value < 0) return false;
        if (value > 6) return false;
        return true;
    }

    // Documented in Enumerated
    //
    @Override
    protected Hashtable<Integer, String> getIntTable() {
        return EnumRowStatus.getRSIntTable();
    }

    // Documented in Enumerated
    //
    @Override
    protected Hashtable<String, Integer> getStringTable() {
        return  EnumRowStatus.getRSStringTable();
    }

    static Hashtable<Integer, String> getRSIntTable() {
        return intTable ;
    }

    static Hashtable<String, Integer> getRSStringTable() {
        return stringTable ;
    }

    // Initialize the mapping tables.
    //
    final static Hashtable<Integer, String> intTable = new Hashtable<>();
    final static Hashtable<String, Integer> stringTable = new Hashtable<>();
    static  {
        intTable.put(new Integer(0), "unspecified");
        intTable.put(new Integer(3), "notReady");
        intTable.put(new Integer(6), "destroy");
        intTable.put(new Integer(2), "notInService");
        intTable.put(new Integer(5), "createAndWait");
        intTable.put(new Integer(1), "active");
        intTable.put(new Integer(4), "createAndGo");
        stringTable.put("unspecified", new Integer(0));
        stringTable.put("notReady", new Integer(3));
        stringTable.put("destroy", new Integer(6));
        stringTable.put("notInService", new Integer(2));
        stringTable.put("createAndWait", new Integer(5));
        stringTable.put("active", new Integer(1));
        stringTable.put("createAndGo", new Integer(4));
    }


}