Package com.inductiveautomation.ignition.gateway.logging

Interface LogPropertyRegistry

public interface LogPropertyRegistry

The Log Property registry is a simple collection of LogPropertyDescriptors. 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.

Method Summary

Modifier and Type	Method	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 LogPropertyDescriptors.
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.

Method Detail

register

void register(LogPropertyDescriptor descriptor)

Adds a new key to the registry if it doesn't exist. If the key does not already exist, a LogPropertyDescriptor will be created for the key.

get

@Nullable
LogPropertyDescriptor get(java.lang.String propertyKey)

Returns the LogPropertyDescriptor with the matching key, if it exists. If the key does not exist, returns null;

Parameters:

propertyKey - the key for the descriptor

Returns:

matching key, or null if no matching key found.

keys

@Nonnull
java.util.Set<java.lang.String> keys()

Returns a Set of keys collected from the registry's LogPropertyDescriptors.

Returns:

a set of String keys. Will return an empty set if no keys are found.

descriptors

@Nonnull
java.util.List<LogPropertyDescriptor> descriptors()

Returns a an immutable List from the set of LogPropertyDescriptor that currently exist.

Returns:

a set of descriptor objects. If no objects exist, it will return an empty list.

remove

void remove(java.lang.String descriptorKey)

Remove the LogPropertyDescriptor with the specified key if it exists.