From e81c033c9f4af979b7d1abb617bf46777a4fc91c Mon Sep 17 00:00:00 2001 From: Ricky Barrette Date: Fri, 31 Aug 2012 12:09:35 -0400 Subject: [PATCH] Added comments Signed-off-by: Ricky Barrette --- OSJ Forum/AndroidManifest.xml | 2 +- .../osj/forum/ForumDetailActivity.java | 4 ++ .../osj/forum/ForumListActivity.java | 4 ++ .../osj/forum/ForumListFragment.java | 5 ++- .../osj/forum/TopicListFragment.java | 3 +- .../osj/forum/content/ForumAdapter.java | 16 +++++--- .../osj/forum/content/ForumContent.java | 38 ++++++++++++++++++- .../osj/forum/content/SubForumAdapter.java | 14 ++++--- .../osj/forum/content/TopicAdapter.java | 12 ++++-- 9 files changed, 77 insertions(+), 21 deletions(-) diff --git a/OSJ Forum/AndroidManifest.xml b/OSJ Forum/AndroidManifest.xml index 2526b3d..5d2ae80 100644 --- a/OSJ Forum/AndroidManifest.xml +++ b/OSJ Forum/AndroidManifest.xml @@ -1,5 +1,5 @@ (getActivity(), R.layout.simple_list_item_activated_1, R.id.text1, DummyContent.ITEMS)); + setListAdapter(new ArrayAdapter(getActivity(), android.R.layout.simple_list_item_activated_1, android.R.id.text1, DummyContent.ITEMS)); } @Override diff --git a/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumAdapter.java b/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumAdapter.java index 796b39b..11e9136 100644 --- a/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumAdapter.java +++ b/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumAdapter.java @@ -42,14 +42,15 @@ public class ForumAdapter extends BaseAdapter { private LayoutInflater mInflater; /** - * + * Creates a new ForumAdapter * @author ricky barrette */ public ForumAdapter(final Context context) { mInflater = LayoutInflater.from(context); } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getCount() */ @Override @@ -57,7 +58,8 @@ public class ForumAdapter extends BaseAdapter { return ForumContent.ITEMS.size(); } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getItem(int) */ @Override @@ -65,7 +67,8 @@ public class ForumAdapter extends BaseAdapter { return ForumContent.ITEMS.get(position); } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getItemId(int) */ @Override @@ -73,7 +76,8 @@ public class ForumAdapter extends BaseAdapter { return position; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getView(int, android.view.View, android.view.ViewGroup) */ @Override @@ -112,4 +116,4 @@ public class ForumAdapter extends BaseAdapter { return convertView; } -} +} \ No newline at end of file diff --git a/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumContent.java b/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumContent.java index 99d9d88..bb0196a 100644 --- a/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumContent.java +++ b/OSJ Forum/src/com/RickBarrette/osj/forum/content/ForumContent.java @@ -32,30 +32,54 @@ import android.content.Context; import com.RickBarrette.osj.forum.R; /** - * + * This * @author ricky barrette */ public class ForumContent { + /** + * This Forum Object + * @author ricky barrette + */ public static class ForumItem { public String id; public HashMap content; + /** + * Creates a new Forum Item + * @param id + * @param content + * @author ricky barrette + */ public ForumItem(final String id, final HashMap content) { this.id = id; this.content = content; } + /** + * Returns the name of this forum object + */ @Override public String toString() { return (String) content.get("forum_name"); } + /** + * This gets all the categories and sub-forums + * @return array of HashMap + * @author ricky barrette + */ public Object[] getChildren(){ return (Object[]) this.content.get("child"); } + /** + * This gets all the topics for the current forum item + * @param context + * @return + * @author ricky barrette + */ public Object[] getTopics(final Context context){ final XMLRPCClient client = new XMLRPCClient((context.getString(R.string.server))); try { @@ -70,11 +94,21 @@ public class ForumContent { public static List ITEMS = new ArrayList(); public static Map ITEM_MAP = new HashMap(); + /** + * Adds a new Forum Item to the list + * @param item + * @author ricky barrette + */ private static void addItem(final ForumItem item) { ITEMS.add(item); ITEM_MAP.put(item.id, item); } + /** + * Downloads the forum from the internet + * @param context + * @author ricky barrette + */ public static void getForum(Context context){ final XMLRPCClient client = new XMLRPCClient((context.getString(R.string.server))); @@ -88,7 +122,7 @@ public class ForumContent { if(result!= null){ for(int i = 0; i < result.length; i++){ HashMap contentHash = (HashMap) result[i]; - addItem(new ForumItem(new Integer(i).toString(), contentHash)); + addItem(new ForumItem(Integer.valueOf(i).toString(), contentHash)); } } } diff --git a/OSJ Forum/src/com/RickBarrette/osj/forum/content/SubForumAdapter.java b/OSJ Forum/src/com/RickBarrette/osj/forum/content/SubForumAdapter.java index 8b789b6..7cedbd9 100644 --- a/OSJ Forum/src/com/RickBarrette/osj/forum/content/SubForumAdapter.java +++ b/OSJ Forum/src/com/RickBarrette/osj/forum/content/SubForumAdapter.java @@ -31,7 +31,7 @@ import android.widget.TextView; import com.RickBarrette.osj.forum.R; /** - * + * This adapter will be used to display sub-forums to the user * @author ricky barrette */ public class SubForumAdapter extends BaseAdapter { @@ -52,7 +52,8 @@ public class SubForumAdapter extends BaseAdapter { mSubForums = ForumContent.ITEMS.get(position).getChildren(); } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getCount() */ @Override @@ -63,7 +64,8 @@ public class SubForumAdapter extends BaseAdapter { return 0; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getItem(int) */ @Override @@ -71,7 +73,8 @@ public class SubForumAdapter extends BaseAdapter { return (HashMap) mSubForums[position]; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getItemId(int) */ @Override @@ -79,7 +82,8 @@ public class SubForumAdapter extends BaseAdapter { return position; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getView(int, android.view.View, android.view.ViewGroup) */ @Override diff --git a/OSJ Forum/src/com/RickBarrette/osj/forum/content/TopicAdapter.java b/OSJ Forum/src/com/RickBarrette/osj/forum/content/TopicAdapter.java index c8bb32c..4835a19 100644 --- a/OSJ Forum/src/com/RickBarrette/osj/forum/content/TopicAdapter.java +++ b/OSJ Forum/src/com/RickBarrette/osj/forum/content/TopicAdapter.java @@ -52,7 +52,8 @@ public class TopicAdapter extends BaseAdapter { mTopics = topics; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getCount() */ @Override @@ -63,7 +64,8 @@ public class TopicAdapter extends BaseAdapter { return 0; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getItem(int) */ @Override @@ -71,7 +73,8 @@ public class TopicAdapter extends BaseAdapter { return (HashMap) mTopics[position]; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getItemId(int) */ @Override @@ -79,7 +82,8 @@ public class TopicAdapter extends BaseAdapter { return position; } - /* (non-Javadoc) + /** + * (non-Javadoc) * @see android.widget.Adapter#getView(int, android.view.View, android.view.ViewGroup) */ @Override