blob: e33f707244719f3c54e2e77b303929c1db810951 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2003 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 */
25package sun.management.snmp.util;
26
27import com.sun.jmx.snmp.SnmpOid;
28
29/**
30 * Defines the interface implemented by an object that holds
31 * table data.
32 **/
33public interface SnmpTableHandler {
34
35 /**
36 * Returns the data associated with the given index.
37 * If the given index is not found, null is returned.
38 * Note that returning null does not necessarily means that
39 * the index was not found.
40 **/
41 public Object getData(SnmpOid index);
42
43 /**
44 * Returns the index that immediately follows the given
45 * <var>index</var>. The returned index is strictly greater
46 * than the given <var>index</var>, and is contained in the table.
47 * <br>If the given <var>index</var> is null, returns the first
48 * index in the table.
49 * <br>If there are no index after the given <var>index</var>,
50 * returns null.
51 **/
52 public SnmpOid getNext(SnmpOid index);
53
54 /**
55 * Returns true if the given <var>index</var> is present.
56 **/
57 public boolean contains(SnmpOid index);
58
59}