org.soulwing.snmp

Interface VarbindCollection

All Superinterfaces:

Iterable<Varbind>

All Known Implementing Classes:

MutableVarbindCollection

public interface VarbindCollection
extends Iterable<Varbind>

An ordered collection of Varbind objects resulting from an SNMP operation. The collection supports both list-like and map-like access methods.

Author:

Carl Harris

Method Summary

Methods

Modifier and Type	Method and Description
List<Varbind>	asList() Gets the contents of this collection as a immutable List with the same size and order as this collection.
Map<String,Varbind>	asMap() Gets the contents of this collection as a immutable Map indexed using the same keys present in this collection.
Varbind	get(int index) Gets a varbind from the collection.
Varbind	get(String oid) Gets a varbind from the collection.
Set<String>	keySet() Gets the set of keys (MIB names and/or dotted-decimal object identifiers for which a varbind exists in this collection).
List<String>	nextIdentifiers(List<String> oids) Creates a list of object identifiers for a GETNEXT or GETBULK operation.
List<String>	nextIdentifiers(String... oids) Creates a list of object identifiers for a GETNEXT or GETBULK operation.
int	size() Gets the number of varbinds in this collection.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

size

int size()

Gets the number of varbinds in this collection.

Returns:

number of varbinds

keySet

Set<String> keySet()

Gets the set of keys (MIB names and/or dotted-decimal object identifiers for which a varbind exists in this collection).

Returns:

key set

get

Varbind get(int index)

Gets a varbind from the collection.

Parameters:

index - zero-based index of the varbind to retrieve

Returns:

varbind

Throws:

IndexOutOfBoundsException - if index < 0 or .

get

Varbind get(String oid)

Gets a varbind from the collection.

Parameters:

oid - MIB name or dotted-decimal object identifier of the object to retrieve; the specified value must be equal to one of values passed to the SNMP operation that resulted in this varbind collection

Returns:

varbind or null if no varbind exists with the given name

asList

List<Varbind> asList()

Gets the contents of this collection as a immutable List with the same size and order as this collection.

Returns:

list representation

asMap

Map<String,Varbind> asMap()

Gets the contents of this collection as a immutable Map indexed using the same keys present in this collection.

Returns:

map representation

nextIdentifiers

List<String> nextIdentifiers(List<String> oids)

Creates a list of object identifiers for a GETNEXT or GETBULK operation.

The resulting list is a concatenation of the specified oids and the object identifiers associated with the varbinds in this collection, starting at index=oids.size(). This method allows you to easily construct a list of object identifiers where non-repeating objects identifiers are specified in the given oids and repeating object identifiers are extracted from the previously retrieved varbinds.

Parameters:

oids - array of object identifiers to prepend to the resulting list

Returns:

list of object identifiers starting with oids followed by the OIDS associated with the varbinds in this collection, starting at start.

nextIdentifiers

List<String> nextIdentifiers(String... oids)

Creates a list of object identifiers for a GETNEXT or GETBULK operation.

The resulting list is a concatenation of the specified oids and the object identifiers associated with the varbinds in this collection, starting at index=oids.size(). This method allows you to easily construct a list of object identifiers where non-repeating objects identifiers are specified in the given oids and repeating object identifiers are extracted from the previously retrieved varbinds.

Parameters:

oids - array of object identifiers to prepend to the resulting list

Returns:

list of object identifiers starting with oids followed by the OIDS associated with the varbinds in this collection, starting at start.