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: import java.io.IOException;
30: import java.io.InputStream;
31: import java.io.OutputStream;
32: import javax.microedition.pim.PIMItem;
33: import javax.microedition.pim.PIMList;
34:
35: /**
36: * Interface for PIM data encoders and decoders.
37: *
38: */
39: public interface PIMFormat {
40:
41: /**
42: * Gets the code name of this encoding (e.g. "VCARD/2.1").
43: * @return the encoding name
44: */
45: public String getName();
46:
47: /**
48: * Checks to see if a given PIM list type is supported by this encoding.
49: * @param pimListType int representing the PIM list type to check
50: * @return true if the type can be read and written by this encoding,
51: * false otherwise
52: */
53: public boolean isTypeSupported(int pimListType);
54:
55: /**
56: * Constructs one or more PIMItems from serialized data.
57: * @param in Stream containing serialized data
58: * @param encoding Character encoding of the stream
59: * @param list PIMList to which items should be added, or null if the items
60: * should not be part of a list
61: * @return a non-empty array of PIMItems containing the objects described
62: * in the serialized data, or null if no items are available
63: * @throws UnsupportedPIMFormatException if the serialized data cannot be
64: * interpreted by this encoding.
65: * @throws IOException if an error occurs while reading
66: */
67: public PIMItem[] decode(InputStream in, String encoding,
68: PIMList list) throws IOException;
69:
70: /**
71: * Serializes a PIMItem.
72: * @param out Stream to which serialized data is written
73: * @param encoding Character encoding to use for serialized data
74: * @param pimItem The item to write to the stream
75: * @throws IOException if an error occurs while writing
76: */
77: public void encode(OutputStream out, String encoding,
78: PIMItem pimItem) throws IOException;
79:
80: }
|