• R/O
  • SSH
  • HTTPS

pxv: Commit


Commit MetaInfo

Revision5 (tree)
Time2010-09-12 06:44:48
Authorjkawamoto

Log Message

Add javadoc comments

Change Summary

Incremental Difference

--- trunk/src/pxv/User.java (revision 4)
+++ trunk/src/pxv/User.java (revision 5)
@@ -97,8 +97,7 @@
9797 }
9898
9999 //----------------------------------------------------------------------------
100- //
101- //----------------------------------------------------------------------------
100+
102101 /**
103102 * このユーザの投稿画像数を取得する.
104103 *
@@ -105,7 +104,7 @@
105104 * @return 投稿画像総数
106105 */
107106 public int getImageSize(){
108- return this.api.getImageSize(this);
107+ return this.api.getImageSize(this.getId());
109108 }
110109
111110 /**
@@ -115,7 +114,7 @@
115114 * @return 取得した画像のリスト
116115 */
117116 public List<Image> getImages(final int page){
118- return this.api.getImages(this, page);
117+ return this.api.getImages(this.getId(), page);
119118 }
120119
121120 /**
@@ -124,7 +123,7 @@
124123 * @return
125124 */
126125 public int getMyPixivSize(){
127- return this.api.getMyPixivSize(this);
126+ return this.api.getMyPixivSize(this.getId());
128127 }
129128
130129 /**
@@ -134,7 +133,7 @@
134133 * @return 取得したユーザのリスト
135134 */
136135 public List<User> getMyPixivUsers(final int page){
137- return this.api.getMyPixivUsers(this, page);
136+ return this.api.getMyPixivUsers(this.getId(), page);
138137 }
139138
140139 /**
@@ -143,7 +142,7 @@
143142 * @return このユーザのお気に入りユーザ数
144143 */
145144 public int getBookmarkedUserSize(){
146- return this.api.getBookmarkedUserSize(this);
145+ return this.api.getBookmarkedUserSize(this.getId());
147146 }
148147
149148 /**
@@ -153,7 +152,7 @@
153152 * @return 取得したユーザのリスト
154153 */
155154 public List<User> getBookmarkedUsers(final int page){
156- return this.api.getBookmarkedUsers(this, page);
155+ return this.api.getBookmarkedUsers(this.getId(), page);
157156 }
158157
159158 /**
@@ -162,7 +161,7 @@
162161 * @return ブックマークしたイラストの数
163162 */
164163 public int getBookmarkSize(){
165- return this.api.getBookmarkSize(this);
164+ return this.api.getBookmarkSize(this.getId());
166165 }
167166
168167 /**
@@ -172,7 +171,7 @@
172171 * @return 取得したイラストのリスト
173172 */
174173 public List<Image> getBookmarks(final int page){
175- return this.api.getBookmarks(this, page);
174+ return this.api.getBookmarks(this.getId(), page);
176175 }
177176
178177 //----------------------------------------------------------------------------
--- trunk/src/pxv/PixivAPI.java (revision 4)
+++ trunk/src/pxv/PixivAPI.java (revision 5)
@@ -194,50 +194,118 @@
194194 //----------------------------------------------------------------------------
195195 // APIs for new images
196196 //----------------------------------------------------------------------------
197+ /**
198+ * 新着イラスト数を取得する.
199+ *
200+ * @return 新着イラスト数
201+ */
197202 public int getNewImageSize(){
198203 return this.getSize(Type.new_illust, DummyParameter);
199204 }
200205
206+ /**
207+ * 新着イラストを取得する.
208+ *
209+ * @param page 取得するページ番号
210+ * @return 取得したイラストのリスト
211+ */
201212 public List<Image> getNewImages(final int page){
202213 return this.getImages(Type.new_illust, DummyParameter, page);
203214 }
204215
216+ /**
217+ * 新着 MyPixiv イラストの数を取得する.
218+ *
219+ * @return 新着 MyPixiv イラスト数
220+ */
205221 public int getMyPixivNewImageSize(){
206222 return this.getSize(Type.mypixiv_new_illust, DummyParameter);
207223 }
208224
225+ /**
226+ * 新着 MyPixiv イラストを取得する.
227+ *
228+ * @param page 取得するページ番号
229+ * @return 取得したイラストのリスト
230+ */
209231 public List<Image> getMyPixivNewImages(final int page){
210232 return this.getImages(Type.mypixiv_new_illust, DummyParameter, page);
211233 }
212234
235+ /**
236+ * お気に入りユーザの新着イラスト数を取得する.
237+ *
238+ * @return お気に入りユーザの新着イラスト数
239+ */
213240 public int getBookmarkedUserNewImageSize(){
214241 return this.getSize(Type.bookmark_user_new_illust, DummyParameter);
215242 }
216243
244+ /**
245+ * お気に入りユーザの新着イラストを取得する.
246+ *
247+ * @param page 取得するページ番号
248+ * @return 取得したイラストのリスト
249+ */
217250 public List<Image> getBookmarkedUserNewImages(final int page){
218251 return this.getImages(Type.bookmark_user_new_illust, DummyParameter, page);
219252 }
220253
254+ //----------------------------------------------------------------------------
255+
256+ /**
257+ * デイリーランキングのイラスト数を取得する.
258+ *
259+ * @return デイリーランキングのイラスト数
260+ */
221261 public int getDailyRankingImageSize(){
222262 return this.getSize(Type.ranking, Daily);
223263 }
224264
265+ /**
266+ * デイリーランキングのイラストを取得する.
267+ *
268+ * @param page 取得するページ番号
269+ * @return 取得したイラストのリスト
270+ */
225271 public List<Image> getDailyRankingImages(final int page){
226272 return this.getImages(Type.ranking, Daily, page);
227273 }
228274
275+ /**
276+ * ウィークリーランキングのイラスト数を取得する.
277+ *
278+ * @return ウィークリーランキングのイラスト数
279+ */
229280 public int getWeeklyRankingImageSize(){
230281 return this.getSize(Type.ranking, Weekly);
231282 }
232283
284+ /**
285+ * ウィークリーランキングのイラストを取得する.
286+ *
287+ * @param page 取得するページ番号
288+ * @return 取得したイラストのリスト
289+ */
233290 public List<Image> getWeeklyRankingImages(final int page){
234291 return this.getImages(Type.ranking, Weekly, page);
235292 }
236293
294+ /**
295+ * マンスリーランキングのイラスト数を取得する.
296+ *
297+ * @return マンスリーランキングのイラスト数
298+ */
237299 public int getMonthlyRankingImageSize(){
238300 return this.getSize(Type.ranking, Monthly);
239301 }
240302
303+ /**
304+ * マンスリーランキングのイラストを取得する.
305+ *
306+ * @param page 取得するページ番号
307+ * @return 取得したイラストのリスト
308+ */
241309 public List<Image> getMonthlyRankingImages(final int page){
242310 return this.getImages(Type.ranking, Monthly, page);
243311 }
@@ -246,6 +314,14 @@
246314 //----------------------------------------------------------------------------
247315 // APIs for search
248316 //----------------------------------------------------------------------------
317+ /**
318+ * 与えられたキーワードに関連するタグを付加されたイラストを取得する.
319+ *
320+ * @param keyword 問い合わせるキーワード
321+ * @param size 取得するイラスト数
322+ * @return 取得したイラストのリスト
323+ * @throws IOException IOエラーが発生した場合
324+ */
249325 public List<Image> findImagesByTag(final String keyword, final int size) throws IOException{
250326
251327 final String param = String.format("s_mode=s_tag&word=%s", URLEncoder.encode(keyword , UTF8));
@@ -252,6 +328,14 @@
252328 return this.findImages(param, size);
253329 }
254330
331+ /**
332+ * 与えられたキーワードに関連するタイトルを持つイラストを取得する.
333+ *
334+ * @param keyword 問い合わせるキーワード
335+ * @param size 取得するイラスト数
336+ * @return 取得したイラストのリスト
337+ * @throws IOException IOエラーが発生した場合
338+ */
255339 public List<Image> findImagesByTitle(final String keyword, final int size) throws IOException{
256340
257341 final String param = String.format("s_mode=s_tc&word=%s", URLEncoder.encode(keyword , UTF8));
@@ -259,6 +343,14 @@
259343
260344 }
261345
346+ /**
347+ * 与えられた名前のユーザを取得する.
348+ *
349+ * @param name 問い合わせるユーザの名前
350+ * @param size 取得するユーザ数
351+ * @return 取得したユーザのリスト
352+ * @throws IOException IOエラーが発生した場合
353+ */
262354 public List<User> findUsers(final String name, final int size) throws IOException{
263355
264356 final List<User> ret = new ArrayList<User>();
@@ -280,6 +372,13 @@
280372
281373 }
282374
375+ /**
376+ * ID と名前を指定してユーザを取得する.
377+ *
378+ * @param id 取得するユーザの ID
379+ * @param name 取得するユーザの名前
380+ * @return 取得したユーザの User オブジェクト,ユーザが見つからなかった場合は null
381+ */
283382 public User findUser(final int id, final String name){
284383
285384 final List<User> ret = new ArrayList<User>();
@@ -350,71 +449,90 @@
350449 //----------------------------------------------------------------------------
351450 // APIs for user
352451 //----------------------------------------------------------------------------
452+ /**
453+ * 指定したユーザの投稿イラスト数を取得する.
454+ *
455+ * @param userId ユーザ ID
456+ * @return 指定したユーザ ID を持つユーザの投稿イラスト数
457+ */
353458 public int getImageSize(final int userId){
354459 return this.getSizeById(Type.member_illust, userId);
355460 }
356461
357- public int getImageSize(final User user){
358- return this.getImageSize(user.getId());
359- }
360-
462+ /**
463+ * 指定したユーザの投稿イラストを取得する.
464+ *
465+ * @param userId ユーザ ID
466+ * @param page ページ数
467+ * @return 指定したユーザ ID を持つユーザの投稿イラスト
468+ */
361469 public List<Image> getImages(final int userId, final int page){
362470 return this.getImagesByUserId(Type.member_illust, userId, page);
363471 }
364472
365- public List<Image> getImages(final User user, final int page){
366- return this.getImages(user.getId(), page);
367- }
368-
473+ /**
474+ * 指定したユーザの MyPixiv ユーザ数を取得する.
475+ *
476+ * @param userId ユーザ ID
477+ * @return 指定したユーザ ID を持つユーザの MyPixiv ユーザ数
478+ */
369479 public int getMyPixivSize(final int usrId){
370480 return this.getSizeById(Type.mypixiv_all, usrId);
371481 }
372482
373- public int getMyPixivSize(final User user){
374- return this.getMyPixivSize(user.getId());
375- }
376-
483+ /**
484+ * 指定したユーザの MyPixiv ユーザを取得する.
485+ *
486+ * @param userId ユーザ ID
487+ * @param page ページ数
488+ * @return 指定したユーザ ID を持つユーザの MyPixiv ユーザ
489+ */
377490 public List<User> getMyPixivUsers(final int usrId, final int page){
378491 return this.getUsersById(Type.mypixiv_all, usrId, page);
379492 }
380493
381- public List<User> getMyPixivUsers(final User user, final int page){
382- return this.getMyPixivUsers(user.getId(), page);
383- }
384-
494+ /**
495+ * 指定したユーザのお気に入りユーザ数を取得する.
496+ *
497+ * @param userId ユーザ ID
498+ * @return 指定したユーザ ID を持つユーザのお気に入りユーザ数
499+ */
385500 public int getBookmarkedUserSize(final int id){
386501 return this.getSizeById(Type.bookmark_user_all, id);
387502 }
388503
389- public int getBookmarkedUserSize(final User user){
390- return this.getBookmarkedUserSize(user.getId());
391- }
392-
504+ /**
505+ * 指定したユーザのお気に入りユーザを取得する.
506+ *
507+ * @param userId ユーザ ID
508+ * @param page ページ数
509+ * @return 指定したユーザ ID を持つユーザのお気に入りユーザ
510+ */
393511 public List<User> getBookmarkedUsers(final int id, final int page){
394512 return this.getUsersById(Type.bookmark_user_all, id, page);
395513 }
396514
397- public List<User> getBookmarkedUsers(final User user, final int page){
398- return this.getBookmarkedUsers(user.getId(), page);
399- }
400-
515+ /**
516+ * 指定したユーザのブックマーク数を取得する.
517+ *
518+ * @param userId ユーザ ID
519+ * @return 指定したユーザ ID を持つユーザのブックマーク数
520+ */
401521 public int getBookmarkSize(final int id){
402522 return this.getSizeById(Type.bookmark, id);
403523 }
404524
405- public int getBookmarkSize(final User user){
406- return this.getBookmarkSize(user.getId());
407- }
408-
525+ /**
526+ * 指定したユーザのブックマークを取得する.
527+ *
528+ * @param userId ユーザ ID
529+ * @param page ページ数
530+ * @return 指定したユーザ ID を持つユーザのブックマーク
531+ */
409532 public List<Image> getBookmarks(final int id, final int page){
410533 return this.getImagesByUserId(Type.bookmark, id, page);
411534 }
412535
413- public List<Image> getBookmarks(final User user, final int page){
414- return this.getBookmarks(user.getId(), page);
415- }
416-
417-
418536 //============================================================================
419537 // Private methods
420538 //============================================================================
Show on old repository browser