de.eldoria.eldoutilities.debug.DebugDataProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of debugging Show documentation

Utilitites for debugging plugins

There is a newer version: 2.1.7

/*
 *     SPDX-License-Identifier: LGPL-3.0-or-later
 *
 *     Copyright (C) EldoriaRPG Team and Contributor
 */

package de.eldoria.eldoutilities.debug;

import de.eldoria.eldoutilities.debug.data.EntryData;
import org.jetbrains.annotations.NotNull;

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

/**
 * A interface which allows to provide additional data when a plugin is debugged via {@link DebugUtil}.
 * 
 * Use {@link #getDebugInformations()} to provide information about the current object instance.
 * 

 * Use {@link #getDebugProviders()} to provide other debug providers.
 * 

 * Your plugin instance is the entry point for debugging. If you want to use this interface your plugin class has to implement it.
 * 

 * Instance of {@code EldoPlugin} are already a {@link DebugDataProvider}. Just override the method.
 *
 * @since 1.3.4
 */
public interface DebugDataProvider {

    /**
     * Get debug information for the current object instance.
     *
     * @return array of entry data.
     */
    @NotNull
    EntryData[] getDebugInformations();

    /**
     * Get one or more debug providers which should be debugged.
     * 

     * Make sure to avoid loops.
     * 

     * This function will be first tried to call on the plugin instance. This is the debug entry point.
     * Return more debug providers from this inital point.
     * 
     * Returned debug providers can also return other debug providers and so on.
     *
     * @return list of other debug providers.
     */
    @NotNull
    default List getDebugProviders() {
        return Collections.emptyList();
    }
}