com.pi4j.boardinfo.util.command.CommandResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pi4j-core Show documentation
Pi4J Java API & Runtime Library
The newest version!
package com.pi4j.boardinfo.util.command;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  CommandResult.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.pi4j.util.StringUtil;

import java.util.Objects;
import java.util.Optional;

/**
 * Represents the result of executing a command.
 */
public class CommandResult {
    private final boolean success;
    private final String outputMessage;
    private final String errorMessage;

    /**
     * Constructor to create a new CommandResult.
     *
     * @param success       Whether the command execution was successful.
     * @param outputMessage The standard output of the command.
     * @param errorMessage  The error message if the command failed.
     */
    private CommandResult(boolean success, String outputMessage, String errorMessage) {
        this.success = success;
        this.outputMessage = Optional.ofNullable(outputMessage).orElse(StringUtil.EMPTY);
        this.errorMessage = Optional.ofNullable(errorMessage).orElse(StringUtil.EMPTY);
    }

    /**
     * Static method to create a successful CommandResult.
     *
     * @param outputMessage The standard output of the successful command.
     * @return A CommandResult representing a successful command execution.
     */
    public static CommandResult success(String outputMessage) {
        return new CommandResult(true, outputMessage, null);
    }

    /**
     * Static method to create a failed CommandResult.
     *
     * @param errorMessage The error message from the failed command execution.
     * @return A CommandResult representing a failed command execution.
     */
    public static CommandResult failure(String errorMessage) {
        return new CommandResult(false, null, errorMessage);
    }

    /**
     * Returns whether the command execution was successful.
     *
     * @return {@code true} if successful, {@code false} otherwise.
     */
    public boolean isSuccess() {
        return success;
    }

    /**
     * Returns the standard output message from the command.
     *
     * @return The standard output message.
     */
    public String getOutputMessage() {
        return outputMessage;
    }

    /**
     * Returns the error message from the command execution.
     *
     * @return The error message.
     */
    public String getErrorMessage() {
        return errorMessage;
    }

    /**
     * Provides a string representation of the CommandResult object.
     * Useful for logging and debugging.
     *
     * @return A string describing the CommandResult.
     */
    @Override
    public String toString() {
        return String.format("CommandResult{success=%b, outputMessage='%s', errorMessage='%s'}",
                success, outputMessage, errorMessage);
    }

    /**
     * Compares this CommandResult to another object for equality.
     *
     * @param o The object to compare to.
     * @return {@code true} if the objects are equal, {@code false} otherwise.
     */
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        CommandResult that = (CommandResult) o;
        return success == that.success &&
                Objects.equals(outputMessage, that.outputMessage) &&
                Objects.equals(errorMessage, that.errorMessage);
    }

    /**
     * Returns a hash code value for this CommandResult.
     *
     * @return The hash code for this object.
     */
    @Override
    public int hashCode() {
        return Objects.hash(success, outputMessage, errorMessage);
    }
}