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.core.layout;
18  
19  /**
20   * Objects implementing the {@code Encoder} interface know how to convert an object to some binary representation and
21   * write the result to a {@code ByteBuffer}, ideally without creating temporary objects.
22   *
23   * @param <T> the type of objects that the Encoder can encode
24   * @since 2.6
25   */
26  public interface Encoder<T> {
27  
28      /**
29       * Encodes the specified source object to some binary representation and writes the result to the specified
30       * destination.
31       *
32       * @param source the object to encode.
33       * @param destination holds the ByteBuffer to write into.
34       */
35      void encode(T source, ByteBufferDestination destination);
36  }