io.tracee.contextlogger.outputgenerator.RecursiveOutputElementTreeBuilder Maven / Gradle / Ivy

Go to download
package io.tracee.contextlogger.outputgenerator;

import io.tracee.contextlogger.outputgenerator.RecursiveOutputElementTreeBuilderState;
import io.tracee.contextlogger.outputgenerator.outputelements.OutputElement;
import io.tracee.contextlogger.profile.ProfileSettings;

/**
 * Interface for recursively building the deserialization tree.
 */
public interface RecursiveOutputElementTreeBuilder {

    /**
     * Method that is called recursively to create the deserialization tree
     *
     * @param state holds recursion state
     * @param instanceToDeserialize the instance ro be processed
     * @return the output element
     */
    OutputElement convertInstanceRecursively(final RecursiveOutputElementTreeBuilderState state, final Object instanceToDeserialize);

    /**
     * Registers the passed output ellement in the InstanceToOutputElementPool.
     *
     * @param outputElement the output element to be registered
     */
    void registerOutputElement(final OutputElement outputElement);

    /**
     * Checks if instance is already registered.
     *
     * @param outputElement The output element to be checked
     */
    boolean checkIfInstanceIsAlreadyRegistered(final OutputElement outputElement);

    /**
     * Checks if instance is already registered
     *
     * @param outputElement the outputElement instance to get the existing output element for
     */
    OutputElement getRegisteredOutputElementAndMarkItAsMultipleRegistered(final OutputElement outputElement);

    /**
     * Allows access to profile settings
     *
     * @return
     */
    ProfileSettings getProfileSettings();

}