Difference between revisions of "Extensions.Logging.LogLevel"

From emotive
Jump to navigation Jump to search
 
(2 intermediate revisions by one other user not shown)
Line 16: Line 16:
  
 
==Literal==
 
==Literal==
The syntax for [[Literals| Literals for complex data types]] should be used, where the '''member value''' is one of the values in the list.
+
The syntax for [[Literals| Literals for complex data types]] will be used, where the '''member value''' is one of the values in the list.
  
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
LogLevels={ALL|TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF}
+
@LogLevel:ALL|TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
{{ConversionTable |
 
{{ConversionTable |
Integer=Returns the index of the value in the ResultStates enumeration (smallest index is 0) | IntegerSample=<tt>Integer val = ToInteger(@LogLevel:ALL); // Returns 0</tt> |
+
Integer=Returns the index of the value in the LogLevels enumeration (smallest index is 0) | IntegerSample=<tt>Integer val = ToInteger(@LogLevel:ALL); // Returns 0</tt> |
 
String=Returns the name of the enumeration value | StringSample=<tt>String s = ToString(@LogLevel:ALL); // Returns "ALL"</tt>
 
String=Returns the name of the enumeration value | StringSample=<tt>String s = ToString(@LogLevel:ALL); // Returns "ALL"</tt>
 
}}
 
}}
Line 29: Line 29:
 
==Sample==
 
==Sample==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
LogLevel MyLogLevelVariable = @LogLevel:ALL;
+
Logging.LogLevel LogLevelVariable = @LogLevel:ALL;
 
</syntaxhighlight>
 
</syntaxhighlight>

Latest revision as of 02:45, 13 September 2019

Classification

Name LogLevel
Short Description Describing log thresholds used by the SetLogLevel action
Class Simple Data Type
Base Data Type SimpleType
Default Value ALL
Provide a Literal Yes
SpecifiedBy ISO 13209-3
Standard Compliant Yes

Description

LogLevel is an enumeration type describing log thresholds used by the SetLogLevel action.

The list of allowed enumeration values is defined in (see) Logging.

Order Relation

LogLevel values may occur as operands of comparisons. For this case, the following order relation is defined. Started with the lowest value ALL = 0:

ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF

Literal

The syntax for Literals for complex data types will be used, where the member value is one of the values in the list.

@LogLevel:ALL|TRACE|DEBUG|INFO|WARN|ERROR|FATAL|OFF

Core Conversion

The following table shows the rules for conversion to another data type:

Conversion Result Sample
ToBoolean Undefined (should not be used)
ToInteger Returns the index of the value in the LogLevels enumeration (smallest index is 0) Integer val = ToInteger(@LogLevel:ALL); // Returns 0
ToFloat Undefined (should not be used)
ToString Returns the name of the enumeration value String s = ToString(@LogLevel:ALL); // Returns "ALL"
ToByteField Undefined (should not be used)

Sample

Logging.LogLevel LogLevelVariable = @LogLevel:ALL;