FollowersRequest.java :  » Twitter » java-twitter » net » unto » twitter » methods » Java Open Source

package net.unto.twitter.methods;

import java.util.List;

import net.unto.twitter.JsonUtil;
import net.unto.twitter.TwitterProtos.User;

// http://apiwiki.twitter.com/REST+API+Documentation#followers
  
/**
 * Returns the authenticating user's followers, each with current status inline.
 * They are ordered by the order in which they joined Twitter (this is going to
 * be changed).
 */
public final class FollowersRequest extends AbstractRequest {

  public static Builder builder() {
    return new Builder();
  }
  
  FollowersRequest(Builder builder) {
    super(builder);
  }
  
  public static final class Builder extends AbstractRequest.Builder<Builder> {

    Builder() {
      path("/statuses/followers.json");
      authorizationRequired(true);
    }
    
    /**
     * The ID or screen name of the user for whom to request a list of followers.
     * 
     * @param id The ID or screen name of the user for whom to request a list of
     *        followers.
     * @return {@link FollowersRequest}
     */
    public Builder id(String id) {
      assert (id != null);
      path(String.format("/statuses/followers/%s.json", id));
      authorizationRequired(false); 
      return this;
    }
    
    /**
     * Retrieves the next 100 followers.
     * 
     * @param page Retrieves the next 100 followers.
     * @return {@link FollowersRequest}
     */
    public Builder page(int page) {
      return parameter("page", Integer.toString(page));
    }
    
    public FollowersRequest build()  {
      return new FollowersRequest(this);
    }    
  }



  /**
   * Returns the authenticating user's followers, each with current status
   * inline. They are ordered by the order in which they joined Twitter (this is
   * going to be changed).
   */
  public List<User> get() {
    return JsonUtil.newUserList(getJson());
  }
}