YamlLogging (OpenHFT/Chronicle-Wire 2.26ea3 API)

java.lang.Object
- java.lang.Enum<YamlLogging>
- - net.openhft.chronicle.wire.YamlLogging

All Implemented Interfaces:

Serializable, Comparable<YamlLogging>
```
public enum YamlLogging
extends Enum<YamlLogging>
```
Provides utility functions to control the logging of Yaml messages, which can be useful for debugging or generating documentation. The logging settings can be toggled using system properties or programmatically through this class's static methods.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class YamlLogging.YamlLoggingLevel
Enum representing the various logging levels for Yaml.

Nested Classes
Modifier and Type	Class and Description
`static class`	`YamlLogging.YamlLoggingLevel` Enum representing the various logging levels for Yaml.

Field Summary

Fields
Modifier and Type Field and Description

static @NotNull String title

Fields
Modifier and Type	Field and Description
`static @NotNull String`	`title`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`setAll(boolean flag)` Sets the logging flags for all message types (reads/writes for both client and server).
`static void`	`setAll(@NotNull YamlLogging.YamlLoggingLevel level)` Sets the logging flags for all message types based on the provided `YamlLogging.YamlLoggingLevel`.
`static boolean`	`showClientReads()` Checks whether logging for client reads is enabled.
`static void`	`showClientReads(boolean logging)` Sets the flag to determine whether client reads should be logged.
`static boolean`	`showClientWrites()` Checks whether logging for client writes is enabled.
`static void`	`showClientWrites(boolean logging)` Sets the flag to determine whether client writes should be logged.
`static boolean`	`showHeartBeats()` Checks whether heartbeat logging is enabled.
`static void`	`showHeartBeats(boolean log)` Sets the flag to determine whether heartbeats should be logged.
`static boolean`	`showServerReads()` Checks whether logging for server reads is enabled.
`static void`	`showServerReads(boolean logging)` Sets the flag to determine whether server reads should be logged.
`static boolean`	`showServerWrites()` Checks whether logging for server writes is enabled.
`static void`	`showServerWrites(boolean logging)` Sets the flag to determine whether server writes should be logged.
`static YamlLogging`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static YamlLogging[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`static @NotNull String`	`writeMessage()` Retrieves the current message associated with a write operation.
`static void`	`writeMessage(@NotNull String s)` Updates the message associated with a write operation.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - title
```
@NotNull
public static volatile @NotNull String title
```
- Method Detail
  - values
```
public static YamlLogging[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (YamlLogging c : YamlLogging.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static YamlLogging valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - setAll
```
public static void setAll(boolean flag)
```
    Sets the logging flags for all message types (reads/writes for both client and server).
    
    Parameters:
    
    flag - The boolean value to set for all logging flags.
  - setAll
```
public static void setAll(@NotNull
                          @NotNull YamlLogging.YamlLoggingLevel level)
```
    Sets the logging flags for all message types based on the provided YamlLogging.YamlLoggingLevel.
    
    Parameters:
    
    level - The YamlLogging.YamlLoggingLevel determining whether to set or unset the logging flags.
  - showClientReads
```
public static boolean showClientReads()
```
    Checks whether logging for client reads is enabled.
    
    Returns:
    
    true if logging for client reads is enabled; false otherwise.
  - writeMessage
```
public static void writeMessage(@NotNull
                                @NotNull String s)
```
    Updates the message associated with a write operation.
    
    Parameters:
    
    s - The new message to be set.
  - showServerWrites
```
public static void showServerWrites(boolean logging)
```
    Sets the flag to determine whether server writes should be logged.
    
    Parameters:
    
    logging - true to enable logging for server writes; false to disable.
  - showClientWrites
```
public static boolean showClientWrites()
```
    Checks whether logging for client writes is enabled.
    
    Returns:
    
    true if logging for client writes is enabled; false otherwise.
  - writeMessage
```
@NotNull
public static @NotNull String writeMessage()
```
    Retrieves the current message associated with a write operation.
    
    Returns:
    
    The message currently associated with a write operation.
  - showHeartBeats
```
public static boolean showHeartBeats()
```
    Checks whether heartbeat logging is enabled.
    
    Returns:
    
    true if heartbeat logging is enabled; false otherwise.
  - showServerReads
```
public static boolean showServerReads()
```
    Checks whether logging for server reads is enabled.
    
    Returns:
    
    true if logging for server reads is enabled; false otherwise.
  - showHeartBeats
```
public static void showHeartBeats(boolean log)
```
    Sets the flag to determine whether heartbeats should be logged.
    
    Parameters:
    
    log - true to enable heartbeat logging; false to disable.
  - showClientWrites
```
public static void showClientWrites(boolean logging)
```
    Sets the flag to determine whether client writes should be logged.
    
    Parameters:
    
    logging - true to enable logging for client writes; false to disable.
  - showClientReads
```
public static void showClientReads(boolean logging)
```
    Sets the flag to determine whether client reads should be logged.
    
    Parameters:
    
    logging - true to enable logging for client reads; false to disable.
  - showServerWrites
```
public static boolean showServerWrites()
```
    Checks whether logging for server writes is enabled.
    
    Returns:
    
    true if logging for server writes is enabled; false otherwise.
  - showServerReads
```
public static void showServerReads(boolean logging)
```
    Sets the flag to determine whether server reads should be logged.
    
    Parameters:
    
    logging - true to enable logging for server reads; false to disable.

Enum YamlLogging

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Field Detail

title

Method Detail

values

valueOf

setAll

setAll

showClientReads

writeMessage

showServerWrites

showClientWrites

writeMessage

showHeartBeats

showServerReads

showHeartBeats

showClientWrites

showClientReads

showServerWrites

showServerReads