View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.util;
18  
19  /**
20   * Objects that implement this interface can be converted to text, ideally without allocating temporary objects.
21   *
22   * @since 2.6
23   */
24  public interface StringBuilderFormattable {
25  
26      /**
27       * Writes a text representation of this object into the specified {@code StringBuilder}, ideally without allocating
28       * temporary objects.
29       *
30       * @param buffer the StringBuilder to write into
31       */
32      void formatTo(StringBuilder buffer);
33  }