123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196 |
- /*
- * Copyright (c) 2006-2017 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
- * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
- * OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
- * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
- package com.dmdirc.logger;
-
- import com.dmdirc.events.ProgramErrorStatusEvent;
- import com.dmdirc.interfaces.EventBus;
-
- import com.google.common.base.MoreObjects;
- import com.google.common.base.Throwables;
-
- import java.io.Serializable;
- import java.time.LocalDateTime;
- import java.util.Objects;
- import java.util.Optional;
-
- import javax.annotation.Nonnull;
- import javax.annotation.Nullable;
-
- import static com.google.common.base.Preconditions.checkNotNull;
-
- /**
- * Stores a program error.
- */
- public class ProgramError implements Serializable {
-
- /** A version number for this class. */
- private static final long serialVersionUID = 4;
- /** Error icon. */
- private final ErrorLevel level;
- /** Error message. */
- private final String message;
- /** Underlying exception. */
- private final Optional<Throwable> exception;
- /** Date/time error first occurred. */
- private final LocalDateTime date;
- /** The eventbus to post status changes to. */
- private final Optional<EventBus> eventBus;
- /** Is this an application error? */
- private final boolean appError;
- /** Error report Status. */
- private ErrorReportStatus reportStatus;
- /** Has the error been output. */
- private boolean handled;
-
- /**
- * Creates a new instance of ProgramError.
- *
- * @param level Error level
- * @param message Error message
- * @param exception The exception that caused the error, if any.
- * @param date Error time and date
- * @param eventBus The event bus to post status changes to
- */
- public ProgramError(
- @Nonnull final ErrorLevel level,
- @Nonnull final String message,
- @Nullable final Throwable exception,
- @Nonnull final LocalDateTime date,
- @Nullable final EventBus eventBus,
- final boolean appError) {
- checkNotNull(level);
- checkNotNull(message);
- checkNotNull(level);
- checkNotNull(date);
-
- this.level = level;
- this.message = message;
- this.exception = Optional.ofNullable(exception);
- this.date = date;
- this.reportStatus = ErrorReportStatus.WAITING;
- this.eventBus = Optional.ofNullable(eventBus);
- this.appError = appError;
- }
-
- /**
- * Returns this errors level.
- *
- * @return Error level
- */
- public ErrorLevel getLevel() {
- return level;
- }
-
- /**
- * Returns this errors message.
- *
- * @return Error message
- */
- public String getMessage() {
- return message;
- }
-
- public Optional<Throwable> getThrowable() {
- return exception;
- }
-
- public Optional<String> getThrowableAsString() {
- return exception.map(Throwables::getStackTraceAsString);
- }
-
- /**
- * Returns this errors time.
- *
- * @return Error time
- */
- public LocalDateTime getDate() {
- return date;
- }
-
- /**
- * Returns the reportStatus of this error.
- *
- * @return Error reportStatus
- */
- public ErrorReportStatus getReportStatus() {
- return reportStatus;
- }
-
- /**
- * Sets the report Status of this error.
- *
- * @param newStatus new ErrorReportStatus for the error
- */
- public void setReportStatus(final ErrorReportStatus newStatus) {
- if (newStatus != null && reportStatus != newStatus) {
- reportStatus = newStatus;
- eventBus.ifPresent(e -> e.publishAsync(new ProgramErrorStatusEvent(this)));
- }
- }
-
- /**
- * Set this error as handled.
- */
- public void setHandled() {
- handled = true;
- }
-
- /**
- * Has this error been handled?
- *
- * @return Handled state
- */
- public boolean isHandled() {
- return handled;
- }
-
- /**
- * Is this an application error?
- *
- * @return true iif this is an application error
- */
- public boolean isAppError() {
- return appError;
- }
-
- @Override
- public String toString() {
- return MoreObjects.toStringHelper(this)
- .add("Level", getLevel())
- .add("Status", getReportStatus())
- .add("Message", getMessage())
- .toString();
- }
-
- @Override
- public boolean equals(final Object obj) {
- if (obj instanceof ProgramError) {
- final ProgramError other = (ProgramError) obj;
- return Objects.equals(getLevel(), other.getLevel()) &&
- Objects.equals(getMessage(), other.getMessage()) &&
- Objects.equals(getThrowable(), other.getThrowable());
- }
- return false;
- }
-
- @Override
- public int hashCode() {
- return Objects.hash(level, message, exception);
- }
-
- }
|