| J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1998-2007 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | |
| 27 | package com.sun.jmx.snmp; |
| 28 | |
| 29 | |
| 30 | /** |
| 31 | * Is used internally to signal that the size of a PDU exceeds the packet size limitation. |
| 32 | * <p> |
| 33 | * You will not usually need to use this class, except if you |
| 34 | * decide to implement your own |
| 35 | * {@link com.sun.jmx.snmp.SnmpPduFactory SnmPduFactory} object. |
| 36 | * <p> |
| 37 | * The <CODE>varBindCount</CODE> property contains the |
| 38 | * number of <CODE>SnmpVarBind</CODE> successfully encoded |
| 39 | * before the exception was thrown. Its value is 0 |
| 40 | * when this number is unknown. |
| 41 | * |
| 42 | * <p><b>This API is a Sun Microsystems internal API and is subject |
| 43 | * to change without notice.</b></p> |
| 44 | */ |
| 45 | |
| 46 | public class SnmpTooBigException extends Exception { |
| 47 | private static final long serialVersionUID = 4754796246674803969L; |
| 48 | |
| 49 | /** |
| 50 | * Builds an <CODE>SnmpTooBigException</CODE> with |
| 51 | * <CODE>varBindCount</CODE> set to 0. |
| 52 | */ |
| 53 | public SnmpTooBigException() { |
| 54 | varBindCount = 0 ; |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Builds an <CODE>SnmpTooBigException</CODE> with |
| 59 | * <CODE>varBindCount</CODE> set to the specified value. |
| 60 | * @param n The <CODE>varBindCount</CODE> value. |
| 61 | */ |
| 62 | public SnmpTooBigException(int n) { |
| 63 | varBindCount = n ; |
| 64 | } |
| 65 | |
| 66 | |
| 67 | /** |
| 68 | * Returns the number of <CODE>SnmpVarBind</CODE> successfully |
| 69 | * encoded before the exception was thrown. |
| 70 | * |
| 71 | * @return A positive integer (0 means the number is unknown). |
| 72 | */ |
| 73 | public int getVarBindCount() { |
| 74 | return varBindCount ; |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * The <CODE>varBindCount</CODE>. |
| 79 | * @serial |
| 80 | */ |
| 81 | private int varBindCount ; |
| 82 | } |