Class ASelfTest

    • Field Detail

      • mInstanceName

        protected java.lang.String mInstanceName
      • mPrefix

        protected java.lang.String mPrefix
    • Constructor Detail

      • ASelfTest

        public ASelfTest()
    • Method Detail

      • shutdownSelfTest

        public abstract void shutdownSelfTest()
        Stops this subsystem. The subsystem may call shutdownSelfTest anytime after initialization.

        Specified by:
        shutdownSelfTest in interface ISelfTest
      • getSelfTestName

        public java.lang.String getSelfTestName()
        Returns the name associated with this self test. This method may return null if the self test has not been intialized.

        Specified by:
        getSelfTestName in interface ISelfTest
        Returns:
        instanceName of this self test
      • getSelfTestConfigStore

        public IConfigStore getSelfTestConfigStore()
        Returns the root configuration storage (self test parameters) associated with this subsystem.

        Specified by:
        getSelfTestConfigStore in interface ISelfTest
        Returns:
        configuration store (self test parameters) of this subsystem
      • getSelfTestDescription

        public abstract java.lang.String getSelfTestDescription​(java.util.Locale locale)
        Retrieves description associated with an individual self test. This method may return null.

        Specified by:
        getSelfTestDescription in interface ISelfTest
        Parameters:
        locale - locale of the client that requests the description
        Returns:
        description of self test
      • runSelfTest

        public abstract void runSelfTest​(ILogEventListener logger)
                                  throws java.lang.Exception
        Execute an individual self test.

        Specified by:
        runSelfTest in interface ISelfTest
        Parameters:
        logger - specifies logging subsystem
        Throws:
        java.lang.Exception - self test exception