blob: 71eb8be29ce3dff1488b1aad3b27932f51b95258 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
// Copyright 2008 The Android Open Source Project
package com.google.wireless.gdata.parser;
import com.google.wireless.gdata.data.Entry;
import com.google.wireless.gdata.data.Feed;
import java.io.IOException;
/**
* Interface for parsing GData feeds. Uses a "pull" model, where
* entries are not read or parsed until {@link #readNextEntry}
* is called.
*/
public interface GDataParser {
/**
* Starts parsing the feed, returning a {@link Feed} containing information
* about the feed. Note that the {@link Feed} does not contain any
* information about any entries, as the entries have not yet been parsed.
*
* @return The {@link Feed} containing information about the parsed feed.
* @throws ParseException Thrown if the feed cannot be parsed.
*/
// TODO: rename to parseFeed? need to make the API clear.
Feed init() throws ParseException;
/**
* Parses a GData entry. You can either call {@link #init()} or
* {@link #parseStandaloneEntry()} for a given feed.
*
* @return The parsed entry.
* @throws ParseException Thrown if the entry could not be parsed.
*/
Entry parseStandaloneEntry() throws ParseException, IOException;
/**
* Returns whether or not there is more data in the feed.
*/
boolean hasMoreData();
/**
* Reads and parses the next entry in the feed. The {@link Entry} that
* should be filled is passed in -- if null, the entry will be created
* by the parser; if not null, the entry will be cleared and reused.
*
* @param entry The entry that should be filled. Should be null if this is
* the first call to this method. This entry is also returned as the return
* value.
*
* @return The {@link Entry} containing information about the parsed entry.
* If entry was not null, returns the same (reused) object as entry, filled
* with information about the entry that was just parsed. If the entry was
* null, returns a newly created entry (as appropriate for the type of
* feed being parsed).
* @throws ParseException Thrown if the entry cannot be parsed.
*/
Entry readNextEntry(Entry entry) throws ParseException, IOException;
/**
* Cleans up any state in the parser. Should be called when caller is
* finished parsing a GData feed.
*/
void close();
}
|
