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.core.layout;
018
019/**
020 * Objects implementing the {@code Encoder} interface know how to convert an object to some binary representation and
021 * write the result to a {@code ByteBuffer}, ideally without creating temporary objects.
022 *
023 * @param <T> the type of objects that the Encoder can encode
024 * @since 2.6
025 */
026public interface Encoder<T> {
027
028    /**
029     * Encodes the specified source object to some binary representation and writes the result to the specified
030     * destination.
031     *
032     * @param source the object to encode.
033     * @param destination holds the ByteBuffer to write into.
034     */
035    void encode(T source, ByteBufferDestination destination);
036}