eu.bittrade.libs.steemj.plugins.apis.follow.models.operations.FollowOperation.java Source code

Introduction

Here is the source code for eu.bittrade.libs.steemj.plugins.apis.follow.models.operations.FollowOperation.java

Source

/*
 *     This file is part of SteemJ (formerly known as 'Steem-Java-Api-Wrapper')
 * 
 *     SteemJ is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     SteemJ is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 * 
 *     You should have received a copy of the GNU General Public License
 *     along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.bittrade.libs.steemj.plugins.apis.follow.models.operations;

import java.security.InvalidParameterException;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.builder.ToStringBuilder;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

import eu.bittrade.libs.steemj.enums.ValidationType;
import eu.bittrade.libs.steemj.plugins.apis.follow.enums.FollowType;
import eu.bittrade.libs.steemj.protocol.AccountName;
import eu.bittrade.libs.steemj.protocol.operations.CustomJsonOperation;
import eu.bittrade.libs.steemj.protocol.operations.CustomJsonOperationPayload;

/**
 * This class represents the Steem "follow_operation" object.
 * 
 * @author <a href="http://steemit.com/@dez1337">dez1337</a>
 */
public class FollowOperation extends CustomJsonOperationPayload {
    @JsonProperty("follower")
    private AccountName follower;
    @JsonProperty("following")
    private AccountName following;
    @JsonProperty("what")
    private List<FollowType> what;

    /**
     * Create a new follow operation to follow or ignore a user.
     * <b>Attention</b> This operation can't be broadcasted directly. It needs
     * to be added as a payload to a {@link CustomJsonOperation}.
     * 
     * @param follower
     *            The account that wants to follow, unfollow or mute the
     *            <code>following</code> account (see
     *            {@link #setFollower(AccountName)}).
     * @param following
     *            The account to follow, unfollow or mute (see
     *            {@link #setFollowing(AccountName)}).
     * @param what
     *            The action to perform (see {@link #setWhat(List)}).
     * @throws InvalidParameterException
     *             If one of the arguments does not fulfill the requirements.
     */
    @JsonCreator
    public FollowOperation(@JsonProperty("follower") AccountName follower,
            @JsonProperty("following") AccountName following, @JsonProperty("what") List<FollowType> what) {
        this.setFollower(follower);
        this.setFollowing(following);
        this.setWhat(what);
    }

    /**
     * Create an empty follow operation to follow or ignore a user.
     * <b>Attention</b> This operation can't be broadcasted directly. It needs
     * to be added as a payload to a {@link CustomJsonOperation}.
     */
    public FollowOperation() {
        this.setFollower(null);
        this.setFollowing(null);
        this.setWhat(null);
    }

    /**
     * Get the account who follows, unfollows or mutes the
     * {@link #getFollowing()} account.
     * 
     * @return The account name of the follower.
     */
    public AccountName getFollower() {
        return follower;

    }

    /**
     * Set the account who follows, unfollows or mutes the
     * {@link #getFollowing()} account. <b>Notice:</b> The private posting key
     * of this account needs to be stored in the key storage.
     * 
     * @param follower
     *            The account name of the follower.
     */
    public void setFollower(AccountName follower) {
        this.follower = follower;
    }

    /**
     * Get the account the {@link #getFollower()} has followed, unfollowed or
     * muted.
     * 
     * @return The account name of the account to follow, unfollow or mute.
     */
    public AccountName getFollowing() {
        return following;
    }

    /**
     * Get the account who followed, unfollowed or muted the
     * {@link #getFollowing()} account.
     * 
     * @param following
     *            The account name of the account to follow, unfollow or mute.
     */
    public void setFollowing(AccountName following) {
        this.following = following;
    }

    /**
     * Get the information if the {@link #getFollower()} wants to follow,
     * unfollow or mute the {@link #getFollowing()} account (see
     * {@link FollowType}).
     * 
     * @return The follow type.
     */
    public List<FollowType> getWhat() {
        return what;
    }

    /**
     * Define if the {@link #getFollower()} wants to follow, unfollow or mute
     * the {@link #getFollowing()} account (see {@link FollowType}).
     * 
     * @param what
     *            The follow type.
     */
    public void setWhat(List<FollowType> what) {
        if (what == null || what.isEmpty()) {
            this.what = new ArrayList<>();
            this.what.add(FollowType.UNDEFINED);
        } else {
            this.what = what;
        }
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }

    @Override
    public void validate(ValidationType validationType) {
        if (!ValidationType.SKIP_VALIDATION.equals(validationType)) {
            if (this.getFollower() == null) {
                throw new InvalidParameterException("The follower account cannot be null.");
            } else if (this.getFollowing() == null) {
                throw new InvalidParameterException("The following account cannot be null.");
            } else if (this.getFollower().equals(this.getFollowing())) {
                throw new InvalidParameterException("You cannot follow yourself.");
            }
        }
    }
}