LogPropertyDescriptor

public interface LogPropertyDescriptor

Method Summary

Modifier and Type

Method

Description

@NonNull String

description()

Returns the localized description of this property, which should be a short sentence tha may provide information about the system or area in which this LogProperty key is relevant.

@NonNull String

key()

Returns the key for the Log Property.

default @NonNull List<String>

values()

Collects and returns the values for this key.

Method Details
- key
  
  @NonNull String key()
  
  Returns the key for the Log Property. The key may only exist once in the LogPropertyRegistry, and should not be null or empty.
- description
  
  @NonNull String description()
  
  Returns the localized description of this property, which should be a short sentence tha may provide information about the system or area in which this LogProperty key is relevant. Should return an empty String if no description is available.
- values
  
  default @NonNull List<String> values()
  
  Collects and returns the values for this key. If no values exist, should return an empty List. Default implementation allows for descriptor implementations that may want to only provide a key.
  
  Returns:
  
  a list of values, or an empty list. Should not return null.