01: /*
02: *
03: *
04: * Copyright 1990-2007 Sun Microsystems, Inc. All Rights Reserved.
05: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License version
09: * 2 only, as published by the Free Software Foundation.
10: *
11: * This program is distributed in the hope that it will be useful, but
12: * WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * General Public License version 2 for more details (a copy is
15: * included at /legal/license.txt).
16: *
17: * You should have received a copy of the GNU General Public License
18: * version 2 along with this work; if not, write to the Free Software
19: * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA
21: *
22: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
23: * Clara, CA 95054 or visit www.sun.com if you need additional
24: * information or have any questions.
25: */
26:
27: package com.sun.kvem.midp.pim;
28:
29: /**
30: * Representation of a PIM field.
31: * See EmptyPIMField, ScalarPIMField and VectorPIMField.
32: *
33: */
34:
35: interface PIMField {
36:
37: /**
38: * Adds a value to a PIM field.
39: * @param attributes properties to update
40: * @param value entry to be updated
41: */
42: public void addValue(int attributes, Object value);
43:
44: /**
45: * Gets current value.
46: * @param index field identifier
47: * @return requested field
48: */
49: public Object getValue(int index);
50:
51: /**
52: * Sets the field value.
53: * @param attributes field properties
54: * @param value field to update
55: * @param index field offset
56: */
57: public void setValue(int attributes, Object value, int index);
58:
59: /**
60: * Gets the field attributes.
61: * @param index field offset
62: * @return coded attribute settings
63: */
64: public int getAttributes(int index);
65:
66: /**
67: * Checks field for contents.
68: * @return <code>true</code> if contains data
69: */
70: public boolean containsData();
71:
72: /**
73: * Gets the count of values.
74: * @return count
75: */
76: public int getValueCount();
77:
78: /**
79: * Removes the value.
80: * @param index value offset
81: */
82: public void removeValue(int index);
83:
84: /**
85: * Check if field contains scalar value.
86: * @return <code>true</code> if scalar value
87: */
88: public boolean isScalar();
89:
90: }
|