com.cedarsolutions.exception.context.RootCause Maven / Gradle / Ivy
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* C E D A R
* S O L U T I O N S "Software done right."
* S O F T W A R E
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Copyright (c) 2014 Kenneth J. Pronovici.
* All rights reserved.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the Apache License, Version 2.0.
* See LICENSE for more information about the licensing terms.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* Author : Kenneth J. Pronovici
* Language : Java 6
* Project : Common Java Functionality
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
package com.cedarsolutions.exception.context;
import com.cedarsolutions.shared.domain.TranslatableDomainObject;
import com.flipthebird.gwthashcodeequals.EqualsBuilder;
import com.flipthebird.gwthashcodeequals.HashCodeBuilder;
/**
* Translatable root cause for an exception.
*
*
* GWT does not return the exception cause hierarchy back to the client. This
* is because the GWT compiler can't be certain that it will be able to
* successfully serialize every exception in the hierarchy. Unfortunately,
* this results in a lot of lost information. Often, the cause hiearchy is
* quite useful in deciding what error message to show to a client. For
* instance, we might want to know that our ServiceException was caused by a
* NotImplementedException, so we can show a better error in the UI.
*
*
*
* This root cause class preserves as much of the exception hierarchy as
* possible. We can't save off the actual Class object because it's not
* translatable. However, we can save off useful information from the class,
* like its name and canonical name. That should be enough, even if it's not
* as clean as we might hope. Unfortunately, the code to create the root cause
* is not translatable, so it has to live server-side in ExceptionUtils.
*
*
* @author Kenneth J. Pronovici
* @see Stack Overflow
*/
public class RootCause extends TranslatableDomainObject {
private static final long serialVersionUID = 1L;
private String name;
private String canonicalName;
private String simpleName;
private String message;
private String location;
private RootCause cause;
public RootCause() {
}
public RootCause(String name, String canonicalName, String simpleName, String message, String location, RootCause cause) {
this.name = name;
this.canonicalName = canonicalName;
this.simpleName = simpleName;
this.message = message;
this.location = location;
this.cause = cause;
}
@Override
public boolean equals(Object obj) {
RootCause other = (RootCause) obj;
return new EqualsBuilder()
.append(this.name, other.name)
.append(this.canonicalName, other.canonicalName)
.append(this.simpleName, other.simpleName)
.append(this.message, other.message)
.append(this.location, other.location)
.append(this.cause, other.cause)
.isEquals();
}
@Override
public int hashCode() {
return new HashCodeBuilder()
.append(this.name)
.append(this.canonicalName)
.append(this.simpleName)
.append(this.message)
.append(this.location)
.append(this.cause)
.toHashCode();
}
public String getName() {
return this.name;
}
public String getCanonicalName() {
return this.canonicalName;
}
public String getSimpleName() {
return this.simpleName;
}
public String getMessage() {
return this.message;
}
public String getLocation() {
return this.location;
}
public RootCause getCause() {
return this.cause;
}
}