scala.util.logging.Logged.scala Maven / Gradle / Ivy

Go to download
/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2003-2010, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |                                         **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */



package scala.util.logging

/** 
 *    Mixing in the class Logged indicates that a class provides
 *    support for logging. For instance, the developer of a library writes
 *  
 *   *    class MyClass extends Logged { /* do stuff, call log */ }
 *  
 *  
 *    The user of the library instantiates:
 *  
 *   *    val x = new MyClass() with ConsoleLogger
 *  
 *  
 *    and the logging will be sent to the Console object.
 *  
 */
trait Logged {

  /** This method should log the message given as argument somewhere
   *  as a side-effect.
   *
   *  @param msg ...
   */
  def log(msg: String): Unit = {}
}