com.phloc.db.jpa.JPAExecutionResult Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]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.
 */
package com.phloc.db.jpa;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.lang.CGStringHelper;
import com.phloc.commons.state.ESuccess;
import com.phloc.commons.state.ISuccessIndicator;
import com.phloc.commons.state.impl.SuccessWithValue;
import com.phloc.commons.string.ToStringGenerator;

/**
 * Represents the result of a single transaction/select within this module. It
 * consists of 3 total fields:
 * 
 * Success/Failure
 * Return object - mostly in case of success
 * Throwable/Exception - mostly in case of error
 * 
 * 
 * @author Philip Helger
 * @param 
 *        Main object value type.
 */
public class JPAExecutionResult  extends SuccessWithValue 
{
  private final Throwable m_aThrowable;

  public JPAExecutionResult (@Nonnull final ISuccessIndicator aSuccessIndicator,
                             @Nullable final DATATYPE aObj,
                             @Nullable final Throwable aThrowable)
  {
    super (aSuccessIndicator, aObj);
    m_aThrowable = aThrowable;
  }

  /**
   * @return The exception passed in the constructor. May be null.
   * @see #hasThrowable()
   */
  @Nullable
  public Throwable getThrowable ()
  {
    return m_aThrowable;
  }

  /**
   * @return true if an exception is present, false if
   *         not.
   * @see #getThrowable()
   */
  public boolean hasThrowable ()
  {
    return m_aThrowable != null;
  }

  /**
   * @return The supplied value.
   * @throws Throwable
   *         if a Throwable is present
   * @see #get()
   * @see #hasThrowable()
   * @see #getThrowable()
   */
  @Nullable
  public DATATYPE getOrThrow () throws Throwable
  {
    if (hasThrowable ())
      throw getThrowable ();
    return get ();
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!super.equals (o))
      return false;
    final JPAExecutionResult  rhs = (JPAExecutionResult ) o;
    return EqualsUtils.equals (CGStringHelper.getSafeClassName (m_aThrowable),
                               CGStringHelper.getSafeClassName (rhs.m_aThrowable));
  }

  @Override
  public int hashCode ()
  {
    return HashCodeGenerator.getDerived (super.hashCode ())
                            .append (CGStringHelper.getSafeClassName (m_aThrowable))
                            .getHashCode ();
  }

  @Override
  public String toString ()
  {
    return ToStringGenerator.getDerived (super.toString ()).append ("throwable", m_aThrowable).toString ();
  }

  @Nonnull
  public static  JPAExecutionResult  createSuccess (@Nonnull final T aObj)
  {
    return new JPAExecutionResult  (ESuccess.SUCCESS, aObj, null);
  }

  @Nonnull
  public static  JPAExecutionResult  createFailure (@Nullable final Throwable t)
  {
    return new JPAExecutionResult  (ESuccess.FAILURE, null, t);
  }
}