com.adventnet.snmp.snmp2
Class SnmpNotifyFilterEntry

java.lang.Object
  |
  +--com.adventnet.snmp.snmp2.SnmpNotifyFilterEntry

All Implemented Interfaces:

java.io.Serializable

public class SnmpNotifyFilterEntry

extends java.lang.Object

implements java.io.Serializable

An element of a filter profile.

See Also:

Serialized Form

Field Summary

static int	EXCLUDED
static int	INCLUDED

Constructor Summary

SnmpNotifyFilterEntry(byte[] profileName, int[] subTree)
Constructs a new SnmpNotifyFilterEntry with the specified SnmpFilterProfileEntry and the SnmpNotifyFilterSubtree.

Method Summary

byte[]	getFilterMask() Retrieves the snmpNotifyFilterMask value associated with this object.
byte[]	getFilterProfileName() Gets the SnmpFilterProfileName associated with this object.
int[]	getFilterSubTree() Gets the SnmpFilterSubTree associated with this object.
int	getFilterType() Retrieves the snmpNotifyFilterType value associated with this object.
java.lang.Object	getKey() Returns the key associated with this SnmpNotifyFilterEntry
static java.lang.Object	getKey(byte[] filterProfileName, int[] filterSubTree) Retrieves the key corresponding to the given snmpNotifyFilterProfileName and snmpNotifyFilterSubTree.
int	getRowStatus() Retrieves the snmpNotifyFilterRowStatus value associated with this object.
int	getStorageType() Retrieves the snmpNotifyFilterStorageType value associated with this object.
void	setFilterMask(byte[] mask) Sets the filterMask value if the size of the mask value is between 0 to 16.
void	setFilterType(int type) Sets the filterType value associated with this object.
void	setRowStatus(int status) Sets the snmpNotifyFilterRowStatus value associated with this object.
void	setStorageType(int type) Sets the snmpNotifyFilterStorageType value associated with this object.

Methods inherited from class java.lang.Object

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

Field Detail

INCLUDED

public static final int INCLUDED

EXCLUDED

public static final int EXCLUDED

Constructor Detail

SnmpNotifyFilterEntry

public SnmpNotifyFilterEntry(byte[] profileName,
                             int[] subTree)

Constructs a new SnmpNotifyFilterEntry with the specified SnmpFilterProfileEntry and the SnmpNotifyFilterSubtree.

Parameters:

profileName - The snmpNotifyFilterProfileName used to create a new SnmpNotifyFilterEntry.

subTree - The SnmpNotifyFilterSubTree used to create a new SnmpNotifyFilterEntry.

Method Detail

getFilterProfileName

public byte[] getFilterProfileName()

Gets the SnmpFilterProfileName associated with this object.

Returns:

The SnmpFilterProfileName associated with this object.

getFilterSubTree

public int[] getFilterSubTree()

Gets the SnmpFilterSubTree associated with this object.

Returns:

The SnmpFilterSubTree associated with this object.

setFilterMask

public void setFilterMask(byte[] mask)

Sets the filterMask value if the size of the mask value is between 0 to 16.

Parameters:

mask - The snmpNotifyFilterMask value to be associated with this object.

getFilterMask

public byte[] getFilterMask()

Retrieves the snmpNotifyFilterMask value associated with this object.

Returns:

the snmpNotifyFilterMask value associated with this object.

setFilterType

public void setFilterType(int type)

Sets the filterType value associated with this object.

Parameters:

type - The snmpNotifyFilterType value to be associated with this object.

getFilterType

public int getFilterType()

Retrieves the snmpNotifyFilterType value associated with this object.

Returns:

the snmpNotifyFilterType value associated with this object.

setStorageType

public void setStorageType(int type)

Sets the snmpNotifyFilterStorageType value associated with this object.

Parameters:

type - The snmpNotifyFilterStorageType value to be associated with this object.

getStorageType

public int getStorageType()

Retrieves the snmpNotifyFilterStorageType value associated with this object.

Returns:

the snmpNotifyFilterStorageType value associated with this object.

setRowStatus

public void setRowStatus(int status)

Sets the snmpNotifyFilterRowStatus value associated with this object.

Parameters:

status - The snmpNotifyFilterRowStatus value to be associated with this object.

getRowStatus

public int getRowStatus()

Retrieves the snmpNotifyFilterRowStatus value associated with this object.

Returns:

the snmpNotifyFilterRowStatus value associated with this object.

getKey

public java.lang.Object getKey()

Returns the key associated with this SnmpNotifyFilterEntry

Returns:

The key as a String Object.

Throws:

java.lang.NullPointerException - if the filterProfileName or the filterSubTree is null.

getKey

public static java.lang.Object getKey(byte[] filterProfileName,
                                      int[] filterSubTree)

Retrieves the key corresponding to the given snmpNotifyFilterProfileName and snmpNotifyFilterSubTree.

Parameters:

filterProfileName - The SnmpNotifyFilterProfileName for which the key is to be retrieved.

filterSubTree - The SnmpNotifyFilterSubTree for which the key is to be retrieved.

Returns:

The key as a String Object. This method will return null if any of the argument is null.