Comment.java

package com.sromku.simple.fb.entities;

import android.os.Bundle;

import com.google.gson.annotations.SerializedName;
import com.sromku.simple.fb.Permission;
import com.sromku.simple.fb.utils.GraphPath;

import java.util.Date;
import java.util.List;

/**
 * @author sromku
 * // @see https://developers.facebook.com/docs/graph-api/reference/comment
 */
public class Comment implements Publishable {

    private static final String ID = "id";
    private static final String CAN_COMMENT = "can_comment";
    private static final String CAN_REMOVE = "can_remove";
    private static final String COMMENT_COUNT = "comment_count";
    private static final String CREATED_TIME = "created_time";
    private static final String FROM = "from";
    private static final String LIKE_COUNT = "like_count";
    private static final String MESSAGE = "message";
    private static final String MESSAGE_TAGS = "message_tags";
    private static final String PARENT = "parent";
    private static final String USER_LIKES = "user_likes";
    private static final String ATTACHMENT = "attachment";
    private static final String ATTACHMENT_URL = "attachment_url";

    @SerializedName(ID)
    private String mId;

    @SerializedName(ATTACHMENT)
    private Attachment mAttachment;

    @SerializedName(CAN_COMMENT)
    private Boolean mCanComment;

    @SerializedName(CAN_REMOVE)
    private Boolean mCanRemove;

    @SerializedName(COMMENT_COUNT)
    private Integer mCommentCount;

    @SerializedName(CREATED_TIME)
    private Date mCreatedTime;

    @SerializedName(FROM)
    private User mFrom;

    @SerializedName(LIKE_COUNT)
    private Integer mLikeCount;

    @SerializedName(MESSAGE)
    private String mMessage;

    @SerializedName(MESSAGE_TAGS)
    private List<Post.InlineTag> mMessageTags;

    @SerializedName(PARENT)
    private Comment mParent;

    @SerializedName(USER_LIKES)
    private Boolean mUserLikes;

    @SerializedName(ATTACHMENT_URL)
    private String mAttachmentUrl;

    private Comment(Builder builder) {
        mMessage = builder.mMessage;
        mAttachmentUrl = builder.mAttachmentUrl;
    }

    @Override
    public Bundle getBundle() {
        Bundle bundle = new Bundle();

        // add name
        if (mMessage != null) {
            bundle.putString(MESSAGE, mMessage);
        }

        // add attachment
        if (mAttachmentUrl != null) {
            bundle.putString(ATTACHMENT_URL, mAttachmentUrl);
        }

        return bundle;
    }

    @Override
    public String getPath() {
        return GraphPath.COMMENTS;
    }

    @Override
    public Permission getPermission() {
        return Permission.PUBLISH_ACTION;
    }

    /**
     * The comment Id.
     */
    public String getId() {
        return mId;
    }

    /**
     * Get attachments to this comment. Thay may include photos and links.
     */
    public Attachment getAttachment() {
        return mAttachment;
    }

    /**
     * Whether the viewer can reply to this comment.
     */
    public Boolean getCanComment() {
        return mCanComment;
    }

    /**
     * Whether the viewer can remove this comment.
     */
    public Boolean getCanRemove() {
        return mCanRemove;
    }

    /**
     * Number of replies to this comment.
     */
    public Integer getCommentCount() {
        return mCommentCount;
    }

    /**
     * The time this comment was made.
     */
    public Date getCreatedTime() {
        return mCreatedTime;
    }

    /**
     * The person that made this comment.
     */
    public User getFrom() {
        return mFrom;
    }

    /**
     * Number of times this comment was liked.
     */
    public Integer getLikeCount() {
        return mLikeCount;
    }

    /**
     * The comment text.
     */
    public String getMessage() {
        return mMessage;
    }

    /**
     * Profiles tagged in mentions in the message.
     */
    public List<Post.InlineTag> getMessageTags() {
        return mMessageTags;
    }

    /**
     * For comment replies, this the comment that this is a reply to.
     */
    public Comment getParent() {
        return mParent;
    }

    /**
     * Whether the viewer has liked this comment.
     */
    public Boolean getUserLikes() {
        return mUserLikes;
    }

    /**
     * Builder for preparing the Comment object to be published.
     */
    public static class Builder {
        private String mMessage = null;
        private String mAttachmentUrl = null;

        public Builder() {
        }

        /**
         * Set the comment text
         *
         * @param message
         *            The text of the comment
         */
        public Builder setMessage(String message) {
            mMessage = message;
            return this;
        }

        /**
         * The URL of an image to include as a photo comment
         * @param attachmentImageUrl The image url to be attached to comment
         */
        public Builder setAttachmentImageUrl(String attachmentImageUrl) {
            mAttachmentUrl = attachmentImageUrl;
            return this;
        }

        public Comment build() {
            return new Comment(this);
        }
    }
}