paulscode.sound
Class SoundSystemLogger

java.lang.Object
  extended by paulscode.sound.SoundSystemLogger

public class SoundSystemLogger
extends java.lang.Object

The SoundSystemLogger class handles all status messages, warnings, and error messages for the SoundSystem library. This class can be extended and methods overriden to change how messages are handled. To do this, the overridden class should be instantiated, and a call should be made to method SoundSystemConfig.setLogger() BEFORE creating the SoundSystem object. If the setLogger() method is called after the SoundSystem has been created, there will be handles floating around to two different message loggers, and the results will be undesirable. See SoundSystemConfig for more information about changing default settings. If an alternate logger is not set by the user, then an instance of this base class will be automatically created by default when the SoundSystem class is instantiated.

SoundSystem License:

You are free to use this library for any purpose, commercial or otherwise. You may modify this library or source code, and distribute it any way you like, provided the following conditions are met:
1) You may not falsely claim to be the author of this library or any unmodified portion of it.
2) You may not copyright this library or a modified version of it and then sue me for copyright infringement.
3) If you modify the source code, you must clearly document the changes made before redistributing the modified source code, so other users know it is not the original code.
4) You are not required to give me credit for this library in any derived work, but if you do, you must also mention my website: http://www.paulscode.com
5) I the author will not be responsible for any damages (physical, financial, or otherwise) caused by the use if this library or any part of it.
6) I the author do not guarantee, warrant, or make any representations, either expressed or implied, regarding the use of this library or any part of it.

Author: Paul Lamb
http://www.paulscode.com


Constructor Summary
SoundSystemLogger()
           
 
Method Summary
 boolean errorCheck(boolean error, java.lang.String classname, java.lang.String message, int indent)
          Prints the specified message if error is true.
 void errorMessage(java.lang.String classname, java.lang.String message, int indent)
          Prints the classname which generated the error, followed by the error message.
 void importantMessage(java.lang.String message, int indent)
          Prints an important message.
 void message(java.lang.String message, int indent)
          Prints a message.
 void printExceptionMessage(java.lang.Exception e, int indent)
          Prints an exception's error message.
 void printStackTrace(java.lang.Exception e, int indent)
          Prints an exception's error message followed by the stack trace.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SoundSystemLogger

public SoundSystemLogger()
Method Detail

message

public void message(java.lang.String message,
                    int indent)
Prints a message.

Parameters:
message - Message to print.
indent - Number of tabs to indent the message.

importantMessage

public void importantMessage(java.lang.String message,
                             int indent)
Prints an important message.

Parameters:
message - Message to print.
indent - Number of tabs to indent the message.

errorCheck

public boolean errorCheck(boolean error,
                          java.lang.String classname,
                          java.lang.String message,
                          int indent)
Prints the specified message if error is true.

Parameters:
error - True or False.
classname - Name of the class checking for an error.
message - Message to print if error is true.
indent - Number of tabs to indent the message.
Returns:
True if error is true.

errorMessage

public void errorMessage(java.lang.String classname,
                         java.lang.String message,
                         int indent)
Prints the classname which generated the error, followed by the error message.

Parameters:
classname - Name of the class which generated the error.
message - The actual error message.
indent - Number of tabs to indent the message.

printStackTrace

public void printStackTrace(java.lang.Exception e,
                            int indent)
Prints an exception's error message followed by the stack trace.

Parameters:
e - Exception containing the information to print.
indent - Number of tabs to indent the message and stack trace.

printExceptionMessage

public void printExceptionMessage(java.lang.Exception e,
                                  int indent)
Prints an exception's error message.

Parameters:
e - Exception containing the message to print.
indent - Number of tabs to indent the message.