com.cd.reddit.json.jackson

Class RedditJsonParser

java.lang.Object

com.cd.reddit.json.jackson.RedditJsonParser

public class RedditJsonParser
extends Object

Uses a combination of Jacksons Tree Model and Data Binding APIs to parse Reddit API JSON.

Future implementations can and should use the Streaming API for great justice.

Author:

Cory Dissinger

See Also:

Reddit's Full, Live Built-In Documentation, Reddit JSON Structure Reference

Constructor Summary

Constructors

Constructor and Description
RedditJsonParser(String string) It would probably be smarter to use refernces to Stream objects rather than Strings.

Method Summary

Methods

Modifier and Type	Method and Description
List<RedditAccount>	parseAccounts() Parses all Account type Things from a given JSON object.
RedditComments	parseComments() Comments are a strange beast.
RedditJsonMessage	parseJsonMessage() This may not work for all Reddit API JSON response 'messages' Sometimes the message is nested within a "json" key, as is the case for /api/login and /api/comment.
List<RedditLink>	parseLinks() Parses JSON containing any number of Link type Things.
List<RedditMessage>	parseMessages() Parses JSON containing any number of Message type Things.
List<RedditComment>	parseMoreChildren() Parses JSON from a Reddit API morechildren call.
List<RedditSubreddit>	parseSubreddits() Parses JSON containing any number of Subreddit type Things.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedditJsonParser

public RedditJsonParser(String string)

It would probably be smarter to use refernces to Stream objects rather than Strings. Strings are the bane of JVM performance.

Parameters:

string - The entire JSON object

Method Detail

parseJsonMessage

public RedditJsonMessage parseJsonMessage()
                                   throws RedditException

This may not work for all Reddit API JSON response 'messages' Sometimes the message is nested within a "json" key, as is the case for /api/login and /api/comment. Do not assume this will work in all cases. YMMV.

Returns:

RedditJsonMessage The parsed JSON message

Throws:

RedditException

parseComments

public RedditComments parseComments()
                             throws RedditException

Comments are a strange beast. Currently this method only parses correctly for JSON retrieved by commentsFor method.

Returns:

RedditComments Comments object.

Throws:

RedditException

parseMoreChildren

public List<RedditComment> parseMoreChildren()
                                      throws RedditException

Parses JSON from a Reddit API morechildren call. The structure of this JSON is very bizarre, please see src/test/resources/example-morechildren.json.

Returns:

List All of the Comment type things found in the morechildren JSON

Throws:

RedditException

parseLinks

public List<RedditLink> parseLinks()
                            throws RedditException

Parses JSON containing any number of Link type Things.
Useful with:

Returns:

List All of the Link type things found in the JSON object

Throws:

RedditException

parseAccounts

public List<RedditAccount> parseAccounts()
                                  throws RedditException

Parses all Account type Things from a given JSON object.
Useful with:

Returns:

A list of the Account type Things found within the current JSON object

Throws:

RedditException

parseMessages

public List<RedditMessage> parseMessages()
                                  throws RedditException

Parses JSON containing any number of Message type Things.
Useful with:

Returns:

List

Throws:

RedditException

parseSubreddits

public List<RedditSubreddit> parseSubreddits()
                                      throws RedditException

Parses JSON containing any number of Subreddit type Things.
Useful with:

Returns:

List

Throws:

RedditException