Module org.snmp4j.agent

Package org.snmp4j.agent

Class DefaultMOScope

java.lang.Object

org.snmp4j.agent.DefaultMOScope

All Implemented Interfaces:

MOScope, MutableMOScope

Direct Known Subclasses:

DefaultMOContextScope

public class DefaultMOScope
extends Object
implements MOScope, MutableMOScope

The DefaultMOScope is the default MOScope and MutableMOScope implementation.

Version:

1.0

Author:

Frank Fock

Field Summary

Fields

Modifier and Type	Field	Description
protected org.snmp4j.smi.OID	lowerBound
protected boolean	lowerIncluded
protected org.snmp4j.smi.OID	upperBound
protected boolean	upperIncluded

Constructor Summary

Constructors

Constructor	Description
DefaultMOScope(MOScope other)	Creates a scope from another scope by referencing its bound values.
DefaultMOScope(org.snmp4j.smi.OID lowerBound, boolean lowerIncluded, org.snmp4j.smi.OID upperBound, boolean upperIncluded)	Creates an OID scope from lower and upper bound.

Method Summary

Modifier and Type	Method	Description
boolean	covers(MOScope covered)	Indicates whether this scope covers by the supplied one, that is whether the lower bound of this scope is less or equal to the lower bound of the covered scope and if the upper bound is greater or equal to the upper bound of the covered scope.
static boolean	covers(MOScope scope, MOScope covered)	Indicates whether the first supplied scope covers by second one.
boolean	covers(org.snmp4j.smi.OID oid)	Checks if this scope covers the supplied OID.
boolean	equals(Object obj)
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.
int	hashCode()
boolean	isCovered(MOScope other)	Checks whether the supplied scope is covered by this scope.
boolean	isEmpty()	Checks if this scope is empty or not.
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.
static boolean	overlaps(MOScope scope, MOScope intersected)	Indicates whether the first scope supplied overlaps with the second one.
void	setLowerBound(org.snmp4j.smi.OID lowerBound)	Sets the lower bound OID of the scope.
void	setLowerIncluded(boolean lowerIncluded)	Sets the flag specifying whether the lower bound OID is included in the scope or not.
void	setUpperBound(org.snmp4j.smi.OID upperBound)	Sets the upper bound OID of the scope (can be null for an unbounded scope.
void	setUpperIncluded(boolean upperIncluded)	Sets the flag specifying whether the upper bound OID is included in the scope or not.
void	substractScope(MOScope scope)	Changes the scope to no longer cover any elements in covered by the specified scope.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

lowerBound

protected org.snmp4j.smi.OID lowerBound

upperBound

protected org.snmp4j.smi.OID upperBound

lowerIncluded

protected boolean lowerIncluded

upperIncluded

protected boolean upperIncluded

Constructor Detail

DefaultMOScope

public DefaultMOScope(org.snmp4j.smi.OID lowerBound,
                      boolean lowerIncluded,
                      org.snmp4j.smi.OID upperBound,
                      boolean upperIncluded)

Creates an OID scope from lower and upper bound.

Parameters:

lowerBound - the lower bound of the scope.

lowerIncluded - indicates whether the lower bound is included in the scope or not.

upperBound - the upper bound of the scope, null can be specified to set no upper limit.

upperIncluded - indicates whether the upper bound is included in the scope or not.

DefaultMOScope

public DefaultMOScope(MOScope other)

Creates a scope from another scope by referencing its bound values.

Parameters:

other - another scope.

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

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.

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.

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.

setLowerBound

public void setLowerBound(org.snmp4j.smi.OID lowerBound)

Description copied from interface: MutableMOScope

Sets the lower bound OID of the scope.

Specified by:

setLowerBound in interface MutableMOScope

Parameters:

lowerBound - an OID.

setLowerIncluded

public void setLowerIncluded(boolean lowerIncluded)

Description copied from interface: MutableMOScope

Sets the flag specifying whether the lower bound OID is included in the scope or not.

Specified by:

setLowerIncluded in interface MutableMOScope

Parameters:

lowerIncluded - true if the lower bound is included, false otherwise.

setUpperBound

public void setUpperBound(org.snmp4j.smi.OID upperBound)

Description copied from interface: MutableMOScope

Sets the upper bound OID of the scope (can be null for an unbounded scope.

Specified by:

setUpperBound in interface MutableMOScope

Parameters:

upperBound - an OID or null.

setUpperIncluded

public void setUpperIncluded(boolean upperIncluded)

Description copied from interface: MutableMOScope

Sets the flag specifying whether the upper bound OID is included in the scope or not. This flag has no effect if upperBound is null.

Specified by:

setUpperIncluded in interface MutableMOScope

Parameters:

upperIncluded - true if the upper bound is included, false otherwise.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

covers

public boolean covers(MOScope covered)

Indicates whether this scope covers by the supplied one, that is whether the lower bound of this scope is less or equal to the lower bound of the covered scope and if the upper bound is greater or equal to the upper bound of the covered scope.

Parameters:

covered - a MOScope instance.

Returns:

true if this OID scope covers the supplied one.

covers

public static boolean covers(MOScope scope,
                             MOScope covered)

Indicates whether the first supplied scope covers by second one.

Parameters:

scope - the covering scope.

covered - the covered scope.

Returns:

true if the lower bound of scope is less or equal to the lower bound of covered and if the upper bound is greater or equal to the upper bound of covered.

overlaps

public static boolean overlaps(MOScope scope,
                               MOScope intersected)

Indicates whether the first scope supplied overlaps with the second one. If both scopes are instances of MOContextScope their context must match

Parameters:

scope - a MOScope instance.

intersected - the presumable intersected MOScope.

Returns:

true if scope overlaps any bound of intersected. This is always the case, if the upper bound of both scopes is null.

substractScope

public void substractScope(MOScope scope)

Description copied from interface: MutableMOScope

Changes the scope to no longer cover any elements in covered by the specified scope.

Specified by:

substractScope in interface MutableMOScope

Parameters:

scope - a MOScope instance that defines the range of OIDs that should be no longer in this scope.

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.

isEmpty

public boolean isEmpty()

Checks if this scope is empty or not. An empty scope cannot cover any OID (i.e. lower bound is greater than upper bound).

Returns:

true if lower bound is greater than upper bound or if both bounds equal but one of the bounds is not-included.

toString

public String toString()

Overrides:

toString in class Object