KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snmp4j > agent > mo > snmp > smi > ValueConstraint


1 /*_############################################################################
2   _##
3   _## SNMP4J-Agent - ValueConstraint.java
4   _##
5   _## Copyright (C) 2005-2007 Frank Fock (SNMP4J.org)
6   _##
7   _## Licensed under the Apache License, Version 2.0 (the "License");
8   _## you may not use this file except in compliance with the License.
9   _## You may obtain a copy of the License at
10   _##
11   _## http://www.apache.org/licenses/LICENSE-2.0
12   _##
13   _## Unless required by applicable law or agreed to in writing, software
14   _## distributed under the License is distributed on an "AS IS" BASIS,
15   _## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   _## See the License for the specific language governing permissions and
17   _## limitations under the License.
18   _##
19   _##########################################################################*/

20
21
22 package org.snmp4j.agent.mo.snmp.smi;
23
24 import org.snmp4j.smi.Variable;
25
26 /**
27  * A <code>ValueConstraint</code> instance validates the value ranges of a
28  * SNMP value to match a certain constraint.
29  *
30  * @author Frank Fock
31  * @version 1.0
32  */

33 public interface ValueConstraint {
34
35   /**
36    * Indicates whether a SNMP value matches this value constraint.
37    * @param variable
38    * a SNMP value that has to match the type of SNMP value this
39    * <code>ValueConstraint</code> supports. Otherwise a wrongType error
40    * should be returned instead of throwing a
41    * <code>ClassCastException</code>.
42    * @return
43    * a SNMP error status (e.g. wrongValue) if the value does not match
44    * the constraint, or zero if it matches.
45    */

46   int validate(Variable variable);
47
48 }
49
Popular Tags