org.soulwing.snmp

Class MutableVarbindCollection

java.lang.Object

org.soulwing.snmp.MutableVarbindCollection

All Implemented Interfaces:

Iterable<Varbind>, VarbindCollection

public class MutableVarbindCollection
extends Object
implements VarbindCollection

A mutable VarbindCollection.

Author:

Carl Harris

Constructor Summary

Constructors

Constructor and Description
MutableVarbindCollection()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, String key, Varbind varbind)
void	addIndex(String key, Varbind varbind)
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.
VarbindCollection	immutableCopy() Creates an immutable copy of the receiver.
Iterator<Varbind>	iterator()
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... ids) Creates a list of object identifiers for a GETNEXT or GETBULK operation.
int	size() Gets the number of varbinds in this collection.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MutableVarbindCollection

public MutableVarbindCollection()

Method Detail

immutableCopy

public VarbindCollection immutableCopy()

Creates an immutable copy of the receiver.

Returns:

immutable copy

iterator

public Iterator<Varbind> iterator()

Specified by:

iterator in interface Iterable<Varbind>

size

public int size()

Gets the number of varbinds in this collection.

Specified by:

size in interface VarbindCollection

Returns:

number of varbinds

keySet

public Set<String> keySet()

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

Specified by:

keySet in interface VarbindCollection

Returns:

key set

get

public Varbind get(int index)

Gets a varbind from the collection.

Specified by:

get in interface VarbindCollection

Parameters:

index - zero-based index of the varbind to retrieve

Returns:

varbind

get

public Varbind get(String oid)

Gets a varbind from the collection.

Specified by:

get in interface VarbindCollection

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

public List<Varbind> asList()

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

Specified by:

asList in interface VarbindCollection

Returns:

list representation

asMap

public Map<String,Varbind> asMap()

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

Specified by:

asMap in interface VarbindCollection

Returns:

map representation

nextIdentifiers

public 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.

Specified by:

nextIdentifiers in interface VarbindCollection

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

public List<String> nextIdentifiers(String... ids)

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.

Specified by:

nextIdentifiers in interface VarbindCollection

Parameters:

ids - 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.

add

public void add(int index,
       String key,
       Varbind varbind)

addIndex

public void addIndex(String key,
            Varbind varbind)

toString

public String toString()

Overrides:

toString in class Object