de.agilecoders.wicket.logging.ClientSideLogObject Maven / Gradle / Ivy

Go to download
package de.agilecoders.wicket.logging;

import de.agilecoders.wicket.logging.util.DefaultValues;
import org.apache.wicket.util.string.StringValue;

/**
 * A {@link ClientSideLogObject} represents a log message that was created
 * on client side.
 *
 * @author miha
 */
public class ClientSideLogObject {

    private final StringValue lvl;
    private final StringValue message;
    private final StringValue timestamp;
    private final StringValue stacktrace;
    private final int index;
    private final StringValue line;
    private final StringValue file;

    /**
     * Construct.
     *
     * @param lvl        the log level as {@link StringValue}
     * @param message    the message as {@link StringValue}
     * @param timestamp  the timestamp as {@link StringValue} in UTC format.
     * @param file       the file that has thrown this error
     * @param line       the line in file that has thrown this error
     * @param stacktrace the client side stacktrace
     * @param index      the parameter index that was used on client side to generate this log object
     */
    public ClientSideLogObject(String lvl, String message, long timestamp, String file, String line,
                               String stacktrace, int index) {
        this(StringValue.valueOf(lvl), StringValue.valueOf(message), StringValue.valueOf(timestamp),
             StringValue.valueOf(file), StringValue.valueOf(line), StringValue.valueOf(stacktrace), index);
    }

    /**
     * Construct.
     *
     * @param lvl        the log level as {@link StringValue}
     * @param message    the message as {@link StringValue}
     * @param timestamp  the timestamp as {@link StringValue} in UTC format.
     * @param file       the file that has thrown this error
     * @param line       the line in file that has thrown this error
     * @param stacktrace the client side stacktrace as {@link StringValue}
     * @param index      the param index
     */
    public ClientSideLogObject(StringValue lvl, StringValue message, StringValue timestamp,
                               StringValue file, StringValue line, StringValue stacktrace, int index) {
        this.lvl = lvl;
        this.message = message;
        this.timestamp = timestamp;
        this.stacktrace = stacktrace;
        this.index = index;
        this.file = file;
        this.line = line;
    }

    /**
     * @return parameter index
     */
    public int index() {
        return index;
    }

    /**
     * @return log level as string or "error" if not valid
     */
    public String level() {
        return lvl.toString("error");
    }

    /**
     * @return stacktrace or empty string if non is set
     */
    public String stacktrace() {
        return stacktrace.toString("");
    }


    /**
     * @return the file that has thrown this error
     */
    public String file() {
        return file.toString("");
    }

    /**
     * @return the line in file that has thrown this error
     */
    public String line() {
        return line.toString("");
    }

    /**
     * @return log message or default message if invalid
     */
    public String message() {
        return message.toString(DefaultValues.defaultMessage);
    }

    /**
     * @return timestamp as string or default timestamp if invalid
     */
    public long timestamp() {
        return timestamp.toLong(DefaultValues.defaultTimestamp);
    }

    @Override
    public String toString() {
        return String.format("[%s | %s] %s %s", timestamp(), level(), fileAndLine(), message());
    }

    private String fileAndLine() {
        if (file().isEmpty()) {
            return "";
        } else if (line().isEmpty()) {
            return file() + ":";
        } else {
            return file() + ":" + line() + ":";
        }
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        ClientSideLogObject logObject = (ClientSideLogObject) o;

        if (lvl != null ? !lvl.equals(logObject.lvl) : logObject.lvl != null) {
            return false;
        }
        if (message != null ? !message.equals(logObject.message) : logObject.message != null) {
            return false;
        }
        if (stacktrace != null ? !stacktrace.equals(logObject.stacktrace) : logObject.stacktrace != null) {
            return false;
        }
        if (file != null ? !file.equals(logObject.file) : logObject.file != null) {
            return false;
        }
        if (line != null ? !line.equals(logObject.line) : logObject.line != null) {
            return false;
        }
        if (timestamp != null ? !timestamp.equals(logObject.timestamp) : logObject.timestamp != null) {
            return false;
        }

        return true;
    }

    @Override
    public int hashCode() {
        int result = lvl != null ? lvl.hashCode() : 0;
        result = 31 * result + (message != null ? message.hashCode() : 0);
        result = 31 * result + (stacktrace != null ? stacktrace.hashCode() : 0);
        result = 31 * result + (file != null ? file.hashCode() : 0);
        result = 31 * result + (line != null ? line.hashCode() : 0);
        result = 31 * result + (timestamp != null ? timestamp.hashCode() : 0);
        return result;
    }

    /**
     * @return TRUE, if all values are set
     */
    public boolean isValid() {
        return !message.isEmpty() && !timestamp.isEmpty() && !lvl.isEmpty();
    }
}