org.gudy.azureus2.core3.logging
Class LogAlert

java.lang.Object
  extended by org.gudy.azureus2.core3.logging.LogAlert
All Implemented Interfaces:
LogAlert

public class LogAlert
extends Object
implements LogAlert

Author:
TuxPaper

Field Summary
static int AT_ERROR
           
static int AT_INFORMATION
           
static int AT_WARNING
           
 String details
           
 int entryType
           
 Throwable err
           
 boolean forceNotify
           
 Object[] relatedTo
          A list of events that this entry is related to
 boolean repeatable
           
static boolean REPEATABLE
           
 String text
           
 int timeoutSecs
           
static boolean UNREPEATABLE
           
 
Fields inherited from interface org.gudy.azureus2.plugins.logging.LogAlert
LT_ERROR, LT_INFORMATION, LT_WARNING
 
Constructor Summary
LogAlert(boolean repeatable, int type, String text)
           
LogAlert(boolean repeatable, int type, String text, int timeoutSecs)
           
LogAlert(boolean repeatable, int type, String text, Throwable err)
           
LogAlert(boolean repeatable, String text, Throwable err)
           
LogAlert(Object[] relatedTo, boolean repeatable, int type, String text)
           
LogAlert(Object relatedTo, boolean repeatable, int type, String text)
           
LogAlert(Object relatedTo, boolean repeatable, String text, Throwable err)
           
 
Method Summary
 Object[] getContext()
          Returns the objects associated with the alert - this will return null if the alert isn't associated with such any objects.
 Throwable getError()
          Returns the error associated with the alert - null if there is no error.
 int getGivenTimeoutSecs()
          How long should to display the alert for - this will be the value that was given when creating the alert.
 String getPlainText()
          Returns the text of the message - this will have any formatting stripped out.
 String getText()
          Returns the text of the message - this may include formatting tags (for example, hyperlinks).
 int getTimeoutSecs()
          How long should to display the alert for - this will be either the explicit value given when creating the alert, or a value determined from Azureus's behaviour and its configuration settings.
 int getType()
          Returns the log type of the alert - the value of which will be one of the LT_ constants defined above.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AT_INFORMATION

public static final int AT_INFORMATION
See Also:
Constant Field Values

AT_WARNING

public static final int AT_WARNING
See Also:
Constant Field Values

AT_ERROR

public static final int AT_ERROR
See Also:
Constant Field Values

REPEATABLE

public static final boolean REPEATABLE
See Also:
Constant Field Values

UNREPEATABLE

public static final boolean UNREPEATABLE
See Also:
Constant Field Values

entryType

public int entryType

err

public Throwable err

repeatable

public boolean repeatable

text

public String text

relatedTo

public Object[] relatedTo
A list of events that this entry is related to


timeoutSecs

public int timeoutSecs

details

public String details

forceNotify

public boolean forceNotify
Constructor Detail

LogAlert

public LogAlert(boolean repeatable,
                int type,
                String text)
Parameters:
type -
text -
repeatable -

LogAlert

public LogAlert(boolean repeatable,
                int type,
                String text,
                int timeoutSecs)
Parameters:
type -
text -
repeatable -
timeoutSecs - -1 -> use defaults 0 -> no timeout

LogAlert

public LogAlert(Object[] relatedTo,
                boolean repeatable,
                int type,
                String text)

LogAlert

public LogAlert(Object relatedTo,
                boolean repeatable,
                int type,
                String text)

LogAlert

public LogAlert(boolean repeatable,
                String text,
                Throwable err)

LogAlert

public LogAlert(boolean repeatable,
                int type,
                String text,
                Throwable err)

LogAlert

public LogAlert(Object relatedTo,
                boolean repeatable,
                String text,
                Throwable err)
Parameters:
downloadManagerImpl -
b -
string -
e -
Method Detail

getGivenTimeoutSecs

public int getGivenTimeoutSecs()
Description copied from interface: LogAlert
How long should to display the alert for - this will be the value that was given when creating the alert.

Specified by:
getGivenTimeoutSecs in interface LogAlert
Returns:
How long to display the timeout for - -1 for no explicit value, 0 to display it indefinitely, otherwise it is the number of seconds to display the value for.

getText

public String getText()
Description copied from interface: LogAlert
Returns the text of the message - this may include formatting tags (for example, hyperlinks).

Specified by:
getText in interface LogAlert
Returns:
The text to display.

getError

public Throwable getError()
Description copied from interface: LogAlert
Returns the error associated with the alert - null if there is no error.

Specified by:
getError in interface LogAlert

getType

public int getType()
Description copied from interface: LogAlert
Returns the log type of the alert - the value of which will be one of the LT_ constants defined above.

Specified by:
getType in interface LogAlert

getContext

public Object[] getContext()
Description copied from interface: LogAlert
Returns the objects associated with the alert - this will return null if the alert isn't associated with such any objects.

Specified by:
getContext in interface LogAlert

getTimeoutSecs

public int getTimeoutSecs()
Description copied from interface: LogAlert
How long should to display the alert for - this will be either the explicit value given when creating the alert, or a value determined from Azureus's behaviour and its configuration settings.

Specified by:
getTimeoutSecs in interface LogAlert
Returns:
How long to display the timeout for - 0 to display it indefinitely, otherwise it is the number of seconds to display the value for.

getPlainText

public String getPlainText()
Description copied from interface: LogAlert
Returns the text of the message - this will have any formatting stripped out.

Specified by:
getPlainText in interface LogAlert
Returns:
The text to display.