fr.cenotelie.commons.utils.api.ReplySuccess Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2017 Association Cénotélie (cenotelie.fr)
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this program.
 * If not, see .
 ******************************************************************************/

package fr.cenotelie.commons.utils.api;

import fr.cenotelie.commons.utils.TextUtils;

/**
 * Implements a simple successful reply to a request
 *
 * @author Laurent Wouters
 */
public class ReplySuccess implements Reply {
    /**
     * The singleton instance
     */
    private static ReplySuccess INSTANCE = null;

    /**
     * Gets the default instance
     *
     * @return The default instance
     */
    public synchronized static ReplySuccess instance() {
        if (INSTANCE == null)
            INSTANCE = new ReplySuccess("OK");
        return INSTANCE;
    }

    /**
     * The associated message
     */
    private final String message;

    /**
     * Initializes this success
     *
     * @param message The associated message
     */
    public ReplySuccess(String message) {
        this.message = message;
    }

    @Override
    public boolean isSuccess() {
        return true;
    }

    @Override
    public String getMessage() {
        return message;
    }

    @Override
    public String serializedString() {
        return message == null ? "OK" : ("OK: " + message);
    }

    @Override
    public String serializedJSON() {
        return "{\"type\": \"" +
                TextUtils.escapeStringJSON(Reply.class.getCanonicalName()) +
                "\", \"kind\": \"" +
                TextUtils.escapeStringJSON(ReplySuccess.class.getSimpleName()) +
                "\", \"isSuccess\": true," +
                "\"message\": \"" + TextUtils.escapeStringJSON(message != null ? message : "OK") + "\"}";
    }
}