public interface LogPropertyRegistry
LogPropertyDescriptor
s. This collection in itself has
no functional use in the Gateway system on its own. Instead, it is provided as a list of 'known' properties can
can be registered for use in graphical components where logging settings are altered. This way, Ignition users
may gain better awareness of what Log Property keys and values may be useful for thier needs.Modifier and Type | Method and Description |
---|---|
java.util.List<LogPropertyDescriptor> |
descriptors()
Returns a an immutable
List from the set of LogPropertyDescriptor that currently exist. |
LogPropertyDescriptor |
get(java.lang.String propertyKey)
Returns the
LogPropertyDescriptor with the matching key, if it exists. |
java.util.Set<java.lang.String> |
keys()
Returns a
Set of keys collected from the registry's LogPropertyDescriptor s. |
void |
register(LogPropertyDescriptor descriptor)
Adds a new key to the registry if it doesn't exist.
|
void |
remove(java.lang.String descriptorKey)
Remove the
LogPropertyDescriptor with the specified key if it exists. |
void register(LogPropertyDescriptor descriptor)
LogPropertyDescriptor
will be created for the key.@Nullable LogPropertyDescriptor get(java.lang.String propertyKey)
LogPropertyDescriptor
with the matching key, if it exists. If the key does not exist, returns
null;propertyKey
- the key for the descriptor@Nonnull java.util.Set<java.lang.String> keys()
Set
of keys collected from the registry's LogPropertyDescriptor
s.String
keys. Will return an empty set if no keys are found.@Nonnull java.util.List<LogPropertyDescriptor> descriptors()
List
from the set of LogPropertyDescriptor
that currently exist.void remove(java.lang.String descriptorKey)
LogPropertyDescriptor
with the specified key if it exists.