Module org.snmp4j.agent

Package org.snmp4j.agent.mo.snmp

Class DisplayString<V extends org.snmp4j.smi.OctetString>

java.lang.Object

org.snmp4j.agent.mo.MOColumn<V>

org.snmp4j.agent.mo.MOMutableColumn<V>

org.snmp4j.agent.mo.snmp.DisplayString<V>

Type Parameters:

V - the OctetString subclass that defines the base Variable class of this display string.

All Implemented Interfaces:

Comparable<MOColumn<V>>

public class DisplayString<V extends org.snmp4j.smi.OctetString>
extends MOMutableColumn<V>

The DisplayString class implements the DisplayString textual convention as defined by the SNMPv2-TC MIB specification for columnar objects.

Version:

3.4.1

Author:

Frank Fock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DisplayString.DisplayStringValidation	The DisplayStringValidation can be used to validate the contents of OctetString variables that follow the DisplayString TC rules.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_SIZE
static final int	MIN_SIZE

Constructor Summary

Constructors

Constructor	Description
DisplayString(int columnID, MOAccess access, V defaultValue)
DisplayString(int columnID, MOAccess access, V defaultValue, boolean mutableInService)
DisplayString(int columnID, MOAccess access, V defaultValue, boolean mutableInService, int minSize, int maxSize)

Method Summary

Modifier and Type	Method	Description
int	validate(V newValue, V oldValue, org.snmp4j.smi.OID instanceOID)	Validate the new value for a mutable column based on old value and (new in v3.7.0) the instance OID.
static <V extends org.snmp4j.smi.Variable> int	validateDisplayString(V displayString, ValueConstraint sizeConstraints)	Validates a variable as a DisplayString OCTET STRING.

Methods inherited from class org.snmp4j.agent.mo.MOMutableColumn

addMOValueValidationListener, cleanup, commit, getDefaultValue, isMandatory, isMutableInService, prepare, removeMOValueValidationListener, setDefaultValue, setMandatory, setMutableInService, toString, undo, validate, validateSetRequest

Methods inherited from class org.snmp4j.agent.mo.MOColumn

compareTo, get, getAccess, getColumnID, getRestoreValue, getStoreValue, getSyntax, getTable, getValue, isVolatile, setAccess, setColumnID, setSyntax, setTable

Methods inherited from class java.lang.Object

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

Field Details

MIN_SIZE

public static final int MIN_SIZE

See Also:

• Constant Field Values

MAX_SIZE

public static final int MAX_SIZE

See Also:

• Constant Field Values

Constructor Details

DisplayString

public DisplayString(int columnID,
 MOAccess access,
 V defaultValue,
 boolean mutableInService)

DisplayString

public DisplayString(int columnID,
 MOAccess access,
 V defaultValue)

DisplayString

public DisplayString(int columnID,
 MOAccess access,
 V defaultValue,
 boolean mutableInService,
 int minSize,
 int maxSize)

Method Details

validate

public int validate(V newValue,
 V oldValue,
 org.snmp4j.smi.OID instanceOID)

Description copied from class: MOMutableColumn

Validate the new value for a mutable column based on old value and (new in v3.7.0) the instance OID.

Overrides:

validate in class MOMutableColumn<V extends org.snmp4j.smi.OctetString>

Parameters:

newValue - the new value to be set.

oldValue - the existing value.

instanceOID - the instance OID of the table cell to be modified.

Returns:

SnmpConstants.SNMP_ERROR_SUCCESS if the change is OK, otherwise a SNMP error status.

validateDisplayString

public static <V extends org.snmp4j.smi.Variable>
int validateDisplayString(V displayString,
 ValueConstraint sizeConstraints)

Validates a variable as a DisplayString OCTET STRING. If the variable is not an OctetString instance, wrongType is returned as error status. Otherwise wrongValue is returned if the string contains non-printable characters other than 'return' and 'new-line'.

Type Parameters:

V - the OctetString subclass that defines the base Variable class of this display string. If V is not an OctetString, SnmpConstants.SNMP_ERROR_WRONG_TYPE will be returned always.

Parameters:

displayString - a variable to validate.

sizeConstraints - a constraint for the size (length) of the string.

Returns:

a SNMP error status if the variable is not a valid DisplayString or zero if it is.