ch.qos.logback.core.encoder.Encoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/**
 * Logback: the reliable, generic, fast and flexible logging framework.
 * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
 *
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *
 *   or (per the licensee's choosing)
 *
 * under the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation.
 */
package ch.qos.logback.core.encoder;

import ch.qos.logback.core.spi.ContextAware;
import ch.qos.logback.core.spi.LifeCycle;

/**
 *  Encoders are responsible for transform an incoming event into a byte array
 *
 *  @author Ceki Gülcü
 *  @author Joern Huxhorn
 *  @author Maarten Bosteels
 *
 *  @param 
 *           event type
 *  @since 0.9.19
 *
 * @deprecated This internal logback API is not supported by AEM as a Cloud Service.
 */
@Deprecated(since = "2022-01-27")
public interface Encoder extends ContextAware, LifeCycle {

    /**
     * Get header bytes. This method is typically called upon opening of
     * an output stream.
     *
     * @return header bytes. Null values are allowed.
     */
    byte[] headerBytes();

    /**
     * Encode an event as bytes.
     *
     * @param event
     */
    byte[] encode(E event);

    /**
     * Get footer bytes. This method is typically called prior to the closing
     * of the stream where events are written.
     *
     * @return footer bytes. Null values are allowed.
     */
    byte[] footerBytes();
}