Logging (SARL Agent Oriented Programming Language 0.12.0 API)

All Superinterfaces:

Capacity

All Known Implementing Classes:

LoggingSkill
```
public interface Logging
extends Capacity
```
Gives access to the logging mechanism associated to the agent.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`debug(message : Object, parameters : Object*)` Print the given message at debug logging level.
`void`	`debug(messageProvider : Supplier<String>)` Print the given message at debug logging level.
`void`	`error(message : Object, [exception : Throwable], parameters : Object*)` Print the given message at error logging level.
`void`	`error(messageProvider : Supplier<String>)` Print the given message at error logging level.
`Logger`	`getLogger()` Replies the backend logger.
`int`	`getLogLevel()` Replies the logging level.
`void`	`info(message : Object, parameters : Object*)` Print the given message at information logging level.
`void`	`info(messageProvider : Supplier<String>)` Print the given message at information logging level.
`boolean`	`isDebugLogEnabled()` Replies if the logging system is displaying the debugging messages.
`boolean`	`isErrorLogEnabled()` Replies if the logging system is displaying the errors.
`boolean`	`isInfoLogEnabled()` Replies if the logging system is displaying the information messages.
`boolean`	`isWarningLogEnabled()` Replies if the logging system is displaying the warnings.
`void`	`println(message : Object)` Deprecated. Use `Logging.info(Object,Object...)`.
`void`	`setLoggingName(name : String)` Change the name used for logging.
`void`	`setLogLevel(level : int)` Set the logging level.
`void`	`warning(message : Object, [exception : Throwable], parameters : Object*)` Print the given message at warning logging level.
`void`	`warning(messageProvider : Supplier<String>)` Print the given message at warning logging level.

- Method Detail
  - setLoggingName
```
def setLoggingName(name : String) : void 
```
    Description copied from interface: Logging
    
    Change the name used for logging.
    
    Parameters:
    
    name - the name used for logging.
  - println
```
@Deprecated
def println(message : Object) : void 
```
    Deprecated. Use Logging.info(Object,Object...).
    
    Description copied from interface: Logging
    
    Print the given message at information logging level.
    This function is deprecated. Please use Logging.info(Object,Object...) in place of println.
    
    Parameters:
    
    message - the elements to display.
  - error
```
def error(message : Object,
          [exception : Throwable],
          parameters : Object*) : void 
```
    Description copied from interface: Logging
    
    Print the given message at error logging level.
    
    Parameters:
    
    message - the elements to display. The format of the message must follow MessageFormat.
    
    exception - the exception that is the cause of the error.
    
    parameters - the values to dynamically insert into the message.
  - error
```
def error(messageProvider : Supplier<String>) : void 
```
    Description copied from interface: Logging
    
    Print the given message at error logging level.
    
    Parameters:
    
    messageProvider - provides the error message.
    
    Since:
    
    0.7
  - warning
```
def warning(message : Object,
            [exception : Throwable],
            parameters : Object*) : void 
```
    Description copied from interface: Logging
    
    Print the given message at warning logging level.
    
    Parameters:
    
    message - the elements to display. The format of the message must follow MessageFormat.
    
    exception - the exception that is the cause of the error.
    
    parameters - the values to dynamically insert into the message.
  - warning
```
def warning(messageProvider : Supplier<String>) : void 
```
    Description copied from interface: Logging
    
    Print the given message at warning logging level.
    
    Parameters:
    
    messageProvider - provides the warning message.
    
    Since:
    
    0.7
  - info
```
def info(message : Object,
         parameters : Object*) : void 
```
    Description copied from interface: Logging
    
    Print the given message at information logging level.
    
    Parameters:
    
    message - the elements to display. The format of the message must follow MessageFormat.
    
    parameters - the values to dynamically insert into the message.
  - info
```
def info(messageProvider : Supplier<String>) : void 
```
    Description copied from interface: Logging
    
    Print the given message at information logging level.
    
    Parameters:
    
    messageProvider - provides the info message.
    
    Since:
    
    0.7
  - debug
```
def debug(message : Object,
          parameters : Object*) : void 
```
    Description copied from interface: Logging
    
    Print the given message at debug logging level.
    
    Parameters:
    
    message - the elements to display. The format of the message must follow MessageFormat.
    
    parameters - the values to dynamically insert into the message.
  - debug
```
def debug(messageProvider : Supplier<String>) : void 
```
    Description copied from interface: Logging
    
    Print the given message at debug logging level.
    
    Parameters:
    
    messageProvider - provides the debug message.
    
    Since:
    
    0.7
  - isErrorLogEnabled
```
@Pure
def isErrorLogEnabled() : boolean 
```
    Description copied from interface: Logging
    
    Replies if the logging system is displaying the errors.
    
    Returns:
    
    true if the errors are logged, false if not.
  - isWarningLogEnabled
```
@Pure
def isWarningLogEnabled() : boolean 
```
    Description copied from interface: Logging
    
    Replies if the logging system is displaying the warnings.
    
    Returns:
    
    true if the warnings are logged, false if not.
  - isInfoLogEnabled
```
@Pure
def isInfoLogEnabled() : boolean 
```
    Description copied from interface: Logging
    
    Replies if the logging system is displaying the information messages.
    
    Returns:
    
    true if the information messages are logged, false if not.
  - isDebugLogEnabled
```
@Pure
def isDebugLogEnabled() : boolean 
```
    Description copied from interface: Logging
    
    Replies if the logging system is displaying the debugging messages.
    
    Returns:
    
    true if the debugging messages are logged, false if not.
  - getLogLevel
```
@Pure
def getLogLevel() : int 
```
    Description copied from interface: Logging
    
    Replies the logging level.
    
    Returns:
    
    0 for no logging, 1 for error, 2 for warning, 3 for info, 5 for debug.
  - setLogLevel
```
def setLogLevel(level : int) : void 
```
    Description copied from interface: Logging
    
    Set the logging level.
    
    Parameters:
    
    level - 0 or lower for no logging, 1 for error, 2 for warning, 3 for info, 4 or higher for debug.
  - getLogger
```
@Pure
def getLogger() : Logger 
```
    Description copied from interface: Logging
    
    Replies the backend logger.
    
    Returns:
    
    the backend logger.

Capacity Logging

Method Summary

Method Detail

setLoggingName

println

error

error

warning

warning

info

info

debug

debug

isErrorLogEnabled

isWarningLogEnabled

isInfoLogEnabled

isDebugLogEnabled

getLogLevel

setLogLevel

getLogger