Class LogAlert

  • All Implemented Interfaces:
    LogAlert

    public class LogAlert
    extends java.lang.Object
    implements LogAlert
    • Constructor Summary

      Constructors 
      Constructor Description
      LogAlert​(boolean repeatable, int type, java.lang.String text)  
      LogAlert​(boolean repeatable, int type, java.lang.String text, int timeoutSecs)  
      LogAlert​(boolean repeatable, int type, java.lang.String text, java.lang.Throwable err)  
      LogAlert​(boolean repeatable, java.lang.String text, java.lang.Throwable err)  
      LogAlert​(java.lang.Object[] relatedTo, boolean repeatable, int type, java.lang.String text)  
      LogAlert​(java.lang.Object relatedTo, boolean repeatable, int type, java.lang.String text)  
      LogAlert​(java.lang.Object relatedTo, boolean repeatable, java.lang.String text, java.lang.Throwable err)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object[] getContext()
      Returns the objects associated with the alert - this will return null if the alert isn't associated with such any objects.
      java.lang.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.
      java.lang.String getPlainText()
      Returns the text of the message - this will have any formatting stripped out.
      java.lang.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 the client'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

      • entryType

        public final int entryType
      • err

        public java.lang.Throwable err
      • repeatable

        public final boolean repeatable
      • text

        public java.lang.String text
      • relatedTo

        public java.lang.Object[] relatedTo
        A list of events that this entry is related to
      • timeoutSecs

        public int timeoutSecs
      • details

        public java.lang.String details
      • forceNotify

        public boolean forceNotify
    • Constructor Detail

      • LogAlert

        public LogAlert​(boolean repeatable,
                        int type,
                        java.lang.String text)
        Parameters:
        type -
        text -
        repeatable -
      • LogAlert

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

        public LogAlert​(java.lang.Object[] relatedTo,
                        boolean repeatable,
                        int type,
                        java.lang.String text)
      • LogAlert

        public LogAlert​(java.lang.Object relatedTo,
                        boolean repeatable,
                        int type,
                        java.lang.String text)
      • LogAlert

        public LogAlert​(boolean repeatable,
                        java.lang.String text,
                        java.lang.Throwable err)
      • LogAlert

        public LogAlert​(boolean repeatable,
                        int type,
                        java.lang.String text,
                        java.lang.Throwable err)
      • LogAlert

        public LogAlert​(java.lang.Object relatedTo,
                        boolean repeatable,
                        java.lang.String text,
                        java.lang.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 java.lang.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 java.lang.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 java.lang.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 the client'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 java.lang.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.