com.helger.commons.error.IErrorTextProvider 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.8+ Library with tons of utility classes required in all projects

There is a newer version: 11.1.10

/*
 * Copyright (C) 2014-2022 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;

/**
 * Interface for converting an {@link IError} to a printable representation.
 *
 * @author Philip Helger
 * @since 8.5.1
 */
@FunctionalInterface
public interface IErrorTextProvider
{
  /**
   * Get the provided error as a String
   *
   * @param aError
   *        The error to be converted. May not be null.
   * @param aContentLocale
   *        The content locale to be used. May not be null.
   * @return A non-null String.
   */
  @Nonnull
  String getErrorText (@Nonnull IError aError, @Nonnull Locale aContentLocale);
}