001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.util;
018
019/**
020 * Objects that implement this interface can be converted to text, ideally without allocating temporary objects.
021 *
022 * @since 2.6
023 */
024public interface StringBuilderFormattable {
025
026    /**
027     * Writes a text representation of this object into the specified {@code StringBuilder}, ideally without allocating
028     * temporary objects.
029     *
030     * @param buffer the StringBuilder to write into
031     */
032    void formatTo(StringBuilder buffer);
033}