001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.util;
020
021import org.jpos.log.LogRenderer;
022import org.jpos.log.LogRendererRegistry;
023
024import java.io.PrintStream;
025
026/**
027 * Implemented by objects that can produce a human-readable log representation via {@link #dump(java.io.PrintStream, String)}.
028 * @author apr@cs.com.uy
029 * @version $Id$
030 */
031public interface Loggeable {
032    /**
033     * Dumps a human-readable representation of this object to the print stream.
034     * @param p the output stream
035     * @param indent indentation prefix
036     */
037    void dump(PrintStream p, String indent);
038    /**
039     * Dumps a representation of this object using the specified renderer type.
040     * Falls back to {@link #dump(PrintStream, String)} if no renderer is registered.
041     * @param p the output stream
042     * @param indent indentation prefix
043     * @param type the desired log renderer type
044     */
045    default void dump(PrintStream p, String indent, LogRenderer.Type type) {
046        var renderer = LogRendererRegistry.getRenderer(this.getClass(), type);
047        if (renderer != null)
048            renderer.render (this, p, indent);
049        else
050            dump (p, indent);
051    }
052}