org.phoebus.logbook.LogPropertiesProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-logbook Show documentation

The newest version!

package org.phoebus.logbook;

import java.util.Collections;
import java.util.List;

/**
 * An interface to subscribe property providers. A custom logbook module can use this
 * to - for instance - add a list of {@link Property} objects calculated dynamically when a new
 * log entry is created.
 */
public interface LogPropertiesProvider {

    /**
     * Clients should consider that implementations may take some time to complete, e.g. query a remote
     * endpoint for data.
     * @param logEntry The {@link LogEntry} object as created by the client. Implementations can use this to apply filtering
     *            based on the fields of the log entry.
     * @return A {@link Property} added to a new log entry. An implementation should return null
     * if it applies a filter that rules out the log entry.
     */
    @SuppressWarnings("unused")
    default List getProperties(LogEntry logEntry){
        return Collections.emptyList();
    }

    /**
     * Clients should consider that implementations may take some time to complete, e.g. query a remote
     * endpoint for data.
     * @return A {@link Property} added to a new log entry. An implementation should return null
     * if it applies a filter that rules out the log entry.
     */
    default List getProperties(){
        return Collections.emptyList();
    }
}