org.snmp4j.agent.util
Class OIDScope

java.lang.Object
  org.snmp4j.agent.util.OIDScope

All Implemented Interfaces:

MOScope

public class OIDScope
extends java.lang.Object
implements MOScope

Constructor Summary

OIDScope(org.snmp4j.smi.OID oid)

Method Summary

boolean	covers(org.snmp4j.smi.OID oid) Checks if this scope covers the supplied OID.
org.snmp4j.smi.OID	getLowerBound() Gets the lower bound OID of the scope.
org.snmp4j.smi.OID	getUpperBound() Gets the upper bound OID of the scope.
boolean	isCovered(MOScope other) Checks whether the supplied scope is covered by this scope.
boolean	isLowerIncluded() Indicates whether the lower bound OID is included in the scope or not.
boolean	isOverlapping(MOScope other) Checks whether the supplied scope overlap with this one, thus sharing at least one OID with the supplied one.
boolean	isUpperIncluded() Indicates whether the upper bound OID is included in the scope or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

OIDScope

public OIDScope(org.snmp4j.smi.OID oid)

Method Detail

getLowerBound

public org.snmp4j.smi.OID getLowerBound()

Description copied from interface: MOScope

Gets the lower bound OID of the scope. Whether the lower bound is included or excluded from the scope's region is determined by MOScope.isLowerIncluded().

Specified by:

getLowerBound in interface MOScope

Returns:

an OID.

getUpperBound

public org.snmp4j.smi.OID getUpperBound()

Description copied from interface: MOScope

Gets the upper bound OID of the scope. Whether the upper bound is included or excluded from the scope's region is determined by MOScope.isUpperIncluded().

Specified by:

getUpperBound in interface MOScope

Returns:

OID

isCovered

public boolean isCovered(MOScope other)

Description copied from interface: MOScope

Checks whether the supplied scope is covered by this scope.

Specified by:

isCovered in interface MOScope

Parameters:

other - the MOScope to check

Returns:

true if the lower bound of other is greater or equal than the lower bound of this scope and if the upper bound of other is lower or equal than the upper bound of this scope.

isLowerIncluded

public boolean isLowerIncluded()

Description copied from interface: MOScope

Indicates whether the lower bound OID is included in the scope or not.

Specified by:

isLowerIncluded in interface MOScope

Returns:

true if the lower bound is included.

isUpperIncluded

public boolean isUpperIncluded()

Description copied from interface: MOScope

Indicates whether the upper bound OID is included in the scope or not.

Specified by:

isUpperIncluded in interface MOScope

Returns:

true if the upper bound is included.

isOverlapping

public boolean isOverlapping(MOScope other)

Description copied from interface: MOScope

Checks whether the supplied scope overlap with this one, thus sharing at least one OID with the supplied one.

Specified by:

isOverlapping in interface MOScope

Parameters:

other - a MOScope.

Returns:

true if there exists at least one OID that is included in both scopes.

covers

public boolean covers(org.snmp4j.smi.OID oid)

Description copied from interface: MOScope

Checks if this scope covers the supplied OID.

Specified by:

covers in interface MOScope

Parameters:

oid - an OID.

Returns:

true if oid is greater or equal the scope's lower bound and if it is less or equal its upper bound.