io.github.kwahome.sopa.interfaces.LoggableObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sopa-api Show documentation

Configurable and extensible structured logging on top of `slf4j` API to generate easily parsable log messages in desired formats.

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2018 Kelvin Wahome
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package io.github.kwahome.sopa.interfaces;

/**
 * {@link FunctionalInterface} that can be added to any POJO to enable structured
 * logging whenever it is passed to the logger.
 *
 * @author Kelvin Wahome
 */
@FunctionalInterface
public interface LoggableObject {
    /**
     * Return an {@link Object[]} of key-value pairs with values for logging. e.g:
     *
     *      ["key1", "value1", "key2", "value2"]
     *
     * from:
     *
     *      return {@link Object}[]{"key1", this.getProperty1(), "key2", this.getProperty2()"};
     *
     * @return {@link Object[]} of key-value pairs to log
     */
    Object[] loggableObject();
}