KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > snmp > SNMPObject


1 /*
2  * SNMP Package
3  *
4  * Copyright (C) 2004, Jonathan Sevy <jsevy@mcs.drexel.edu>
5  *
6  * This is free software. Redistribution and use in source and binary forms, with
7  * or without modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice, this
11  * list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  * 3. The name of the author may not be used to endorse or promote products
16  * derived from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
19  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
23  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  *
28  */
29
30
31 package snmp;
32
33
34
35 /**
36 * Abstract base class of all SNMP data type classes.
37 */
38
39
40 public abstract class SNMPObject
41 {
42     
43     /**
44     * Must return a Java object appropriate to represent the value/data contained
45     * in the SNMP object
46     */
47     
48     public abstract Object JavaDoc getValue();
49     
50     
51     
52     /**
53     * Must set the value of the SNMP object when supplied with an appropriate
54     * Java object containing an appropriate value.
55     */
56     
57     public abstract void setValue(Object JavaDoc o)
58         throws SNMPBadValueException;
59     
60     
61     
62     /**
63     * Should return an appropriate human-readable representation of the stored value.
64     */
65         
66     public abstract String JavaDoc toString();
67     
68     
69     
70     /**
71     * Must return the BER byte encoding (type, length, value) of the SNMP object.
72     */
73         
74     protected abstract byte[] getBEREncoding();
75     
76     
77     /**
78     * Compares two SNMPObject subclass objects by checking their values for equality.
79     */
80     
81     public boolean equals(Object JavaDoc other)
82     {
83         // false if other is null
84 if (other == null)
85         {
86             return false;
87         }
88         
89         // check first to see that they're both of the same class
90 if (!this.getClass().equals(other.getClass()))
91         {
92             return false;
93         }
94         
95         SNMPObject otherSNMPObject = (SNMPObject)other;
96          
97         // now see if their embedded values are equal
98 if (this.getValue().equals(otherSNMPObject.getValue()))
99         {
100             return true;
101         }
102         else
103         {
104             return false;
105         }
106     }
107     
108     
109     /**
110     * Generates a hash value so SNMP objects can be used in Hashtables.
111     */
112     
113     public int hashCode()
114     {
115         // just use hashcode value of embedded value by default
116 if (this.getValue() != null)
117         {
118             return this.getValue().hashCode();
119         }
120         else
121         {
122             return 0;
123         }
124     }
125     
126     
127 }
Popular Tags