/*_############################################################################
  _##
  _##  SNMP4J-Agent 3 - MIBTreeFormatter.java
  _##
  _##  Copyright (C) 2005-2026  Frank Fock (SNMP4J.org)
  _##
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##
  _##########################################################################*/

package org.snmp4j.agent.util;

import org.snmp4j.agent.io.prop.MIBTree;

import java.io.IOException;

/**
 * Formats a {@link MIBTree} into a human readable representation.
 *
 * @author SNMP4J.org
 * @version 3.9.2
 * @since 3.9.2
 */
public interface MIBTreeFormatter {

    /**
     * Formats the given MIB tree and returns the result as a string.
     *
     * @param tree
     *    the MIB tree to format.
     * @return the formatted representation.
     */
    String format(MIBTree tree);

    /**
     * Formats the given MIB tree and appends the result to the supplied {@link Appendable}.
     *
     * @param tree
     *    the MIB tree to format.
     * @param out
     *    the target to append the formatted representation to.
     * @throws IOException
     *    if appending to {@code out} fails.
     */
    void format(MIBTree tree, Appendable out) throws IOException;
}
