com.helger.commons.error.IResourceError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-commons Show documentation

Java 1.6+ Library with tons of utility classes required in all projects

There is a newer version: 9.5.5

/**
 * Copyright (C) 2014-2016 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.commons.error;

import java.util.Locale;

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

import com.helger.commons.annotation.Nonempty;
import com.helger.commons.errorlist.IErrorBase;
import com.helger.commons.text.display.IHasDisplayText;

/**
 * Interface for an error that can be drilled down to a certain resource (e.g. a
 * document). The name is a bit misleading, as an "IResourceError" can also
 * contain an INFO or a WARNING message! It has an error level, a multilingual
 * error message, a location and a linked exception.
 *
 * @author Philip Helger
 */
public interface IResourceError extends IHasDisplayText, IErrorBase 
{
  /**
   * @return The non-null location of the error.
   */
  @Nonnull
  IResourceLocation getLocation ();

  /**
   * @return The linked exception or null if no such exception is
   *         available.
   */
  @Nullable
  Throwable getLinkedException ();

  /**
   * @return true if a linked exception is present,
   *         false if not.
   */
  default boolean hasLinkedException ()
  {
    return getLinkedException () != null;
  }

  /**
   * Get the error as a string representation, including error ID, error
   * location, error text and the linked exception.
   *
   * @param aDisplayLocale
   *        Locale to resolve the error text
   * @return The default string representation
   */
  @Nonnull
  @Nonempty
  String getAsString (@Nonnull Locale aDisplayLocale);
}