eu.bittrade.libs.steemj.base.models.Permlink.java Source code

Introduction

Here is the source code for eu.bittrade.libs.steemj.base.models.Permlink.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.base.models;

import java.security.InvalidParameterException;

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

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

import eu.bittrade.libs.steemj.exceptions.SteemInvalidTransactionException;
import eu.bittrade.libs.steemj.interfaces.ByteTransformable;
import eu.bittrade.libs.steemj.util.SteemJUtils;

/**
 * This class represents a "permlink". Steem defines "permlinks" as Strings,
 * which follow a specific pattern. To validate those patterns in SteemJ, this
 * class has been created and wraps the "permlink" String to offer the
 * validation methods.
 * 
 * @author <a href="http://Steemit.com/@dez1337">dez1337</a>
 */
public class Permlink implements ByteTransformable {
    private String link;

    /**
     * Create a new, empty "permlink".
     */
    public Permlink() {
        this.setLink("");
    }

    /**
     * Create a new "permlink".
     * 
     * @param link
     *            The permanent link to set.
     * @throws InvalidParameterException
     *             If the link is not valid (see {@link #setLink(String)}).
     * 
     */
    @JsonCreator
    public Permlink(String link) {
        this.setLink(link);
    }

    /**
     * Get the "permlink" of this instance.
     * 
     * @return The permanent link.
     */
    @JsonValue
    public String getLink() {
        return link;
    }

    /**
     * Set the "permlink" of this instance.
     * 
     * @param link
     *            The "permlink" in its String representation. The link can
     *            either be empty or needs to have a length between 0 and 256
     *            characters. If provided, only "a-z", "0-9" and "-" are allowed
     *            characters.
     * @throws InvalidParameterException
     *             If the link does not fulfill the requirements describes
     *             above.
     */
    public void setLink(String link) {
        if (link == null) {
            this.link = "";
        } else {
            if (!link.isEmpty()) {
                if (link.length() < 0 || link.length() > 256) {
                    throw new InvalidParameterException(
                            "A permlink needs to have a minimum length of 0 and a maximum length of 256.");
                } else if (!link.matches("^[a-z0-9\\-]{0,256}")) {
                    throw new InvalidParameterException(
                            "The provided permlink contains invalid characters. Only 'a-z', '0-9' and '-' are allowed. "
                                    + "If copied from steemit.com, the permlink is only the part of the URL after the last '/'.");
                }
            }

            this.link = link;
        }
    }

    @Override
    public byte[] toByteArray() throws SteemInvalidTransactionException {
        return SteemJUtils.transformStringToVarIntByteArray(this.getLink());
    }

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

    @Override
    public boolean equals(Object otherPermlink) {
        if (this == otherPermlink)
            return true;
        if (otherPermlink == null || !(otherPermlink instanceof Permlink))
            return false;
        Permlink other = (Permlink) otherPermlink;
        return this.getLink().equals(other.getLink());
    }

    @Override
    public int hashCode() {
        int hashCode = 1;
        hashCode = 31 * hashCode + (this.getLink() == null ? 0 : this.getLink().hashCode());
        return hashCode;
    }

    /**
     * Returns {@code true} if, and only if, the permanent link has more than
     * {@code 0} characters.
     *
     * @return {@code true} if the permanent link has more than {@code 0},
     *         otherwise {@code false}
     */
    public boolean isEmpty() {
        return this.getLink().isEmpty();
    }
}