Interface LogPropertyDescriptor
-
public interface LogPropertyDescriptor
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.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.java.lang.String
key()
Returns the key for the Log Property.default java.util.List<java.lang.String>
values()
Collects and returns the values for this key.
-
-
-
Method Detail
-
key
@Nonnull java.lang.String key()
Returns the key for the Log Property. The key may only exist once in theLogPropertyRegistry
, and should not be null or empty.
-
description
@Nonnull java.lang.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 emptyString
if no description is available.
-
values
@Nonnull default java.util.List<java.lang.String> values()
Collects and returns the values for this key. If no values exist, should return an emptyList
. 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.
-
-