Album.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;

/**
 * Album entity.
 *
 * @author sromku
 * // @see https://developers.facebook.com/docs/reference/api/album
 */
public class Album implements Publishable {

    private static final String ID = "id";
    private static final String FROM = "from";
    private static final String NAME = "name";
    private static final String DESCRIPTION = "description";
    private static final String MESSAGE = "message";
    private static final String LOCATION = "location";
    private static final String LINK = "link";
    private static final String COUNT = "count";
    private static final String PRIVACY = "privacy";
    private static final String COVER_PHOTO = "cover_photo";
    private static final String TYPE = "type";
    private static final String CREATED_TIME = "created_time";
    private static final String UPDATED_TIME = "updated_time";
    private static final String CAN_UPLOAD = "can_upload";

    @SerializedName(ID)
    private String mId = null;

    @SerializedName(FROM)
    private User mFrom = null;

    @SerializedName(NAME)
    private String mName = null;

    @SerializedName(DESCRIPTION)
    private String mDescription = null;

    @SerializedName(LOCATION)
    private String mLocation = null;

    @SerializedName(LINK)
    private String mLink = null;

    @SerializedName(COUNT)
    private Integer mCount = null;

    @SerializedName(PRIVACY)
    private String mPrivacy = null;

    @SerializedName(COVER_PHOTO)
    private String mCoverPhotoId = null;

    @SerializedName(TYPE)
    private String mType = null;

    @SerializedName(CREATED_TIME)
    private Date mCreatedTime;

    @SerializedName(UPDATED_TIME)
    private Date mUpdatedTime;

    @SerializedName(CAN_UPLOAD)
    private boolean mCanUpload;

    private Privacy mPublishPrivacy = null;

    private Album(Builder builder) {
        mName = builder.mName;
        mDescription = builder.mMessage;
        mPublishPrivacy = builder.mPublishPrivacy;
    }

    /**
     * The album id.
     *
     * @return The album id
     */
    public String getId() {
        return mId;
    }

    /**
     * The user who created this album.
     *
     * @return The user who created this album
     */
    public User getFrom() {
        return mFrom;
    }

    /**
     * The title of the album.
     *
     * @return The title of the album
     */
    public String getName() {
        return mName;
    }

    /**
     * The description of the album.
     *
     * @return The description of the album
     */
    public String getDescription() {
        return mDescription;
    }

    /**
     * The location of the album.
     *
     * @return The location of the album
     */
    public String getLocation() {
        return mLocation;
    }

    /**
     * A link to this album on Facebook.
     *
     * @return A link to this album on Facebook
     */
    public String getLink() {
        return mLink;
    }

    /**
     * The number of photos in this album.
     *
     * @return The number of photos in this album
     */
    public Integer getCount() {
        return mCount;
    }

    /**
     * The privacy settings for the album.
     *
     * @return The privacy settings for the album
     */
    public String getPrivacy() {
        return mPrivacy;
    }

    /**
     * The album cover photo id.
     *
     * @return The album cover photo id
     */
    public String getCoverPhotoId() {
        return mCoverPhotoId;
    }

    /**
     * The type of the album.
     *
     * @return The type of the album
     */
    public String getType() {
        return mType;
    }

    /**
     * The time the photo album was initially created.
     *
     * @return The time the photo album was initially created
     */
    public Date getCreatedTime() {
        return mCreatedTime;
    }

    /**
     * The last time the photo album was updated.
     *
     * @return The last time the photo album was updated
     */
    public Date getUpdatedTime() {
        return mUpdatedTime;
    }

    /**
     * Determines whether the user can upload to the album and returns true if
     * the user owns the album, the album is not full, and the app can add
     * photos to the album. <br>
     * <br>
     * <b>Important</b> The privacy setting of the app should be at minimum as
     * the privacy setting of the album ({@link #getPrivacy()}.
     *
     * @return <code>True</code> if user can upload to this album
     */
    public boolean canUpload() {
        return mCanUpload;
    }

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

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

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

        // add privacy
        if (mPublishPrivacy != null) {
            bundle.putString(PRIVACY, mPublishPrivacy.getJSONString());
        }

        return bundle;
    }

    /**
     * Builder for preparing the Album object to be published.
     */
    public static class Builder {
        private String mName = null;
        private String mMessage = null;
        private Privacy mPublishPrivacy = null;

        public Builder() {
        }

        /**
         * Add name to the album
         *
         * @param name
         *			The name of the album
         */
        public Builder setName(String name) {
            mName = name;
            return this;
        }

        /**
         * Add description to the album
         *
         * @param message
         *			The description of the album
         */
        public Builder setMessage(String message) {
            mMessage = message;
            return this;
        }

        /**
         * Add privacy setting to the photo
         *
         * @param privacy
         *			The privacy setting of the album
         * @see com.sromku.simple.fb.entities.Privacy
         */
        public Builder setPrivacy(Privacy privacy) {
            mPublishPrivacy = privacy;
            return this;
        }

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

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

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