eu.cedarsoft.utils.ConsolePrinter Maven / Gradle / Ivy

Go to download
package eu.cedarsoft.utils;

import org.jetbrains.annotations.NotNull;

/**
 * Interface that creates messages to be printed to the console.
 * Depending on the implementation the messages may be formated differently.
 * 
 * Implementations use {@link java.text.MessageFormat} to render the message.
 */
public interface ConsolePrinter {
  /**
   * Creates an error message
   *
   * @param message the raw message
   * @param objects the objects
   * @return the error message
   */
  @NotNull
  String createError( String message, Object... objects );

  /**
   * Creates a warning
   *
   * @param message the raw message
   * @param objects the objects
   * @return the warning message
   */
  @NotNull
  String createWarning( String message, Object... objects );

  /**
   * Creates a success message
   *
   * @param message the raw message
   * @param objects the objects
   * @return the success mesage
   */
  @NotNull
  String createSuccess( String message, Object... objects );
}