jdk/src/jdk.snmp/share/classes/com/sun/jmx/snmp/SnmpUnsignedInt.java
author chegar
Sun, 17 Aug 2014 15:54:13 +0100
changeset 25859 3317bb8137f4
parent 23711 jdk/src/share/classes/com/sun/jmx/snmp/SnmpUnsignedInt.java@95fb268275e3
permissions -rw-r--r--
8054834: Modular Source Code Reviewed-by: alanb, chegar, ihse, mduigou Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
23711
95fb268275e3 8039022: Fix serial lint warnings in sun.tools.java
darcy
parents: 5506
diff changeset
     2
 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
package com.sun.jmx.snmp;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * Is the base for all SNMP syntaxes based on unsigned integers.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * <p><b>This API is a Sun Microsystems internal API  and is subject
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * to change without notice.</b></p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 */
23711
95fb268275e3 8039022: Fix serial lint warnings in sun.tools.java
darcy
parents: 5506
diff changeset
    37
@SuppressWarnings("serial") // JDK implementation class
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
public abstract class SnmpUnsignedInt extends SnmpInt {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
     * The largest value of the type <code>unsigned int</code> (2^32 - 1).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
    public static final long   MAX_VALUE = 0x0ffffffffL;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
    // CONSTRUCTORS
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    //-------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     * Constructs a new <CODE>SnmpUnsignedInt</CODE> from the specified integer value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * @param v The initialization value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     * @exception IllegalArgumentException The specified value is negative
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * or larger than {@link #MAX_VALUE SnmpUnsignedInt.MAX_VALUE}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    public SnmpUnsignedInt(int v) throws IllegalArgumentException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
        super(v);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * Constructs a new <CODE>SnmpUnsignedInt</CODE> from the specified <CODE>Integer</CODE> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * @param v The initialization value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * @exception IllegalArgumentException The specified value is negative
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * or larger than {@link #MAX_VALUE SnmpUnsignedInt.MAX_VALUE}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    public SnmpUnsignedInt(Integer v) throws IllegalArgumentException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
        super(v);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * Constructs a new <CODE>SnmpUnsignedInt</CODE> from the specified long value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * @param v The initialization value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * @exception IllegalArgumentException The specified value is negative
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * or larger than {@link #MAX_VALUE SnmpUnsignedInt.MAX_VALUE}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    public SnmpUnsignedInt(long v) throws IllegalArgumentException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
        super(v);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * Constructs a new <CODE>SnmpUnsignedInt</CODE> from the specified <CODE>Long</CODE> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
     * @param v The initialization value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     * @exception IllegalArgumentException The specified value is negative
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * or larger than {@link #MAX_VALUE SnmpUnsignedInt.MAX_VALUE}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    public SnmpUnsignedInt(Long v) throws IllegalArgumentException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
        super(v);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    // PUBLIC METHODS
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    //---------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * Returns a textual description of the type object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     * @return ASN.1 textual description.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
    public String getTypeName() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
        return name ;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     * This method has been defined to allow the sub-classes
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * of SnmpInt to perform their own control at intialization time.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    boolean isInitValueValid(int v) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
        if ((v < 0) || (v > SnmpUnsignedInt.MAX_VALUE)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
            return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
        return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * This method has been defined to allow the sub-classes
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * of SnmpInt to perform their own control at intialization time.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
    boolean isInitValueValid(long v) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
        if ((v < 0) || (v > SnmpUnsignedInt.MAX_VALUE)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
            return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
        return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
    // VARIABLES
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
    //----------
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     * Name of the type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
    final static String name = "Unsigned32" ;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
}