Logger_Sngltn (OKW - OpenKeyWord 0.1.0 API)

java.lang.Object
- okw.log.Logger_Sngltn

public class Logger_Sngltn
extends Object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`AddLogger(ILogger fpLogger)` \~german \brief Fügt einen ILogger der Logger-Liste Logger.LoggerList \param fpLogger Logger, der \return \~english \brief \todo TODO: Brief Description.
`Boolean`	`getDebugMode()`
`static Logger_Sngltn`	`getInstance()`
`static void`	`Init()`
`void`	`LogError(String fps_Message)` \brief LogError Function: Logs an error message to the results file.
`void`	`LogException(String fps_Message)` \brief LogException Function: Logs a Script Exception to the results file.
`void`	`LogFunctionEnd()`
`void`	`LogFunctionEnd(Boolean fpb_Return)`
`void`	`LogFunctionEnd(List<String> fpls_Return)`
`void`	`LogFunctionEnd(String fps_Return)`
`void`	`LogFunctionEndDebug()`
`void`	`LogFunctionEndDebug(Boolean fpb_Return)`
`void`	`LogFunctionEndDebug(List<String> fpLs_Return)`
`void`	`LogFunctionEndDebug(String fps_Return)`
`void`	`LogFunctionStart(String fps_FunctionName, String... fpsParameter)`
`void`	`LogFunctionStartDebug(String fps_FunctionName, String... fpsParameter)`
`void`	`LogKeyWordEnd()`
`void`	`LogKeyWordStart(String fpsKeyWordName, String... fpsParameter)` \~german \brief Ausgabe eines Schlüsselwortes \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description.
`void`	`LogPass(String fps_Message)` \brief LogPass: Logs an passes-message to the result.
`void`	`LogPrint(String fps_Message)` \brief LogPrint Function: Prints the values of expressions to the results file.
`void`	`LogPrintDebug(String fpsMessage)` \~german \brief Loggt eine Nachricht Die Nachricht fpsMessage wird im Ergebniss ausgegeben.
`void`	`LogSequenceEnd()`
`void`	`LogSequenceStart(String fps_KeyWordName, String fpsWinowFN, String fps_SequensName, String... fpsParameter)`
`void`	`LogTestcaseEnd()`
`void`	`LogTestcaseStart(String fps_TestcaseName)` \~german \brief Ausgabe des Testfalls \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description.
`void`	`LogWarning(String fps_Message)` \brief LogWarning Function: Logs a warning to the results file.
`void`	`ResCloseList()` \brief Closes a hierarchical level in the results file that was opened with ResOpenList.
`void`	`ResCloseListDebug()` \brief Closes a hierarchical level in the results file that was opened with ResOpenList.
`void`	`reset()` \~german \brief Initialisi.
`void`	`ResOpenList(String fps_Name)` \brief Creates a new hierarchical level in the results file.
`void`	`ResOpenListDebug(String fpsListCaption)` \~german \brief Erzeugt eine hierachische Log-Ebene in der Ergenbniss-Ausgabe.
`void`	`setDebugMode(Boolean fpbDebugMode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDebugMode
```
public Boolean getDebugMode()
```
  - setDebugMode
```
public void setDebugMode(Boolean fpbDebugMode)
```
  - getInstance
```
public static Logger_Sngltn getInstance()
```
  - Init
```
public static void Init()
```
  - AddLogger
```
public void AddLogger(ILogger fpLogger)
```
    \~german \brief Fügt einen ILogger der Logger-Liste Logger.LoggerList \param fpLogger Logger, der \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param fpbTrueOrFalse \return \~ \author Zoltán Hrabovszki \date 2015.05.01
  - reset
```
public void reset()
```
    \~german \brief Initialisi. \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \~
  - LogError
```
public void LogError(String fps_Message)
```
    \brief LogError Function: Logs an error message to the results file. \param fps_Message
  - LogException
```
public void LogException(String fps_Message)
```
    \brief LogException Function: Logs a Script Exception to the results file. \param fps_Message
  - LogFunctionEnd
```
public void LogFunctionEnd(String fps_Return)
```
  - LogFunctionEnd
```
public void LogFunctionEnd(Boolean fpb_Return)
```
  - LogFunctionEnd
```
public void LogFunctionEnd(List<String> fpls_Return)
```
  - LogFunctionEnd
```
public void LogFunctionEnd()
```
  - LogFunctionEndDebug
```
public void LogFunctionEndDebug()
```
  - LogFunctionEndDebug
```
public void LogFunctionEndDebug(String fps_Return)
```
  - LogFunctionEndDebug
```
public void LogFunctionEndDebug(List<String> fpLs_Return)
```
  - LogFunctionEndDebug
```
public void LogFunctionEndDebug(Boolean fpb_Return)
```
  - LogFunctionStart
```
public void LogFunctionStart(String fps_FunctionName,
                             String... fpsParameter)
```
  - LogFunctionStartDebug
```
public void LogFunctionStartDebug(String fps_FunctionName,
                                  String... fpsParameter)
```
  - LogKeyWordEnd
```
public void LogKeyWordEnd()
```
  - LogSequenceEnd
```
public void LogSequenceEnd()
```
  - LogTestcaseEnd
```
public void LogTestcaseEnd()
```
  - LogKeyWordStart
```
public void LogKeyWordStart(String fpsKeyWordName,
                            String... fpsParameter)
```
    \~german \brief Ausgabe eines Schlüsselwortes \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param fpbTrueOrFalse \return \~ \author Zoltán Hrabovszki \date 2015.05.01
  - LogSequenceStart
```
public void LogSequenceStart(String fps_KeyWordName,
                             String fpsWinowFN,
                             String fps_SequensName,
                             String... fpsParameter)
```
  - LogTestcaseStart
```
public void LogTestcaseStart(String fps_TestcaseName)
```
    \~german \brief Ausgabe des Testfalls \todo TODO: Ausführliche Beschreibung \param Parameterbezeichner \todo TODO: Beschreibung \return \~english \brief \todo TODO: Brief Description. \todo TODO: Detailed Description \param fpbTrueOrFalse \return \~ \author Zoltán Hrabovszki \date 2015.05.01
  - LogPass
```
public void LogPass(String fps_Message)
```
    \brief LogPass: Logs an passes-message to the result. \param fps_Message
  - LogPrint
```
public void LogPrint(String fps_Message)
```
    \brief LogPrint Function: Prints the values of expressions to the results file. \param fps_Message
  - LogPrintDebug
```
public void LogPrintDebug(String fpsMessage)
```
    \~german \brief Loggt eine Nachricht Die Nachricht fpsMessage wird im Ergebniss ausgegeben. \param fpsMessage Nachricht, die Ausgegeben werden soll. \~english \brief \todo TODO: Brief sescription. \todo TODO: Detailed Description \param fpsMessage \return \~ \author Zoltán Hrabovszki \date 2015.05.01 \brief Prints the message fps_Messageof expressions to the results file, if cvb_DebugMode \param fps_Message Message to Print
  - LogWarning
```
public void LogWarning(String fps_Message)
```
    \brief LogWarning Function: Logs a warning to the results file. \param fps_Message
  - ResCloseList
```
public void ResCloseList()
```
    \brief Closes a hierarchical level in the results file that was opened with ResOpenList. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it.
  - ResCloseListDebug
```
public void ResCloseListDebug()
```
    \brief Closes a hierarchical level in the results file that was opened with ResOpenList. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it.
  - ResOpenList
```
public void ResOpenList(String fps_Name)
```
    \brief Creates a new hierarchical level in the results file. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it. \param fps_Name
  - ResOpenListDebug
```
public void ResOpenListDebug(String fpsListCaption)
```
    \~german \brief Erzeugt eine hierachische Log-Ebene in der Ergenbniss-Ausgabe. \todo TODO: Ausführliche Beschreibung erstellen. \param fpsListCaption Überschrift der Log-Ebene. \~english \brief Creates a new hierarchical level in the results file. Use ResOpenList to start a new hierarchical level. The Print commands that follow it are indented until you close the level with ResCloseList. When you view the results file, the item sName is initially collapsed, indicated by the [+] icon next to it. You can expand sName to reveal the indented items under it. \param fpsListCaption Caption of the resultlist. \~ \author Zoltán Hrabovszki \date 2015.05.01

Class Logger_Sngltn

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDebugMode

setDebugMode

getInstance

Init

AddLogger

reset

LogError

LogException

LogFunctionEnd

LogFunctionEnd

LogFunctionEnd

LogFunctionEnd

LogFunctionEndDebug

LogFunctionEndDebug

LogFunctionEndDebug

LogFunctionEndDebug

LogFunctionStart

LogFunctionStartDebug

LogKeyWordEnd

LogSequenceEnd

LogTestcaseEnd

LogKeyWordStart

LogSequenceStart

LogTestcaseStart

LogPass

LogPrint

LogPrintDebug

LogWarning

ResCloseList

ResCloseListDebug

ResOpenList

ResOpenListDebug