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.parser;
018
019import org.apache.logging.log4j.core.LogEvent;
020
021/**
022 * Parse the output from a layout into instances of {@link LogEvent}.
023 */
024public interface LogEventParser {
025    /**
026     * Parses a byte array, which is expected to contain exactly one log event.
027     *
028     * @param input  the byte array
029     *
030     * @return the parsed LogEvent, never {@literal null}.
031     * @throws ParseException if the input is malformed and cannot be parsed as a LogEvent
032     */
033    LogEvent parseFrom(byte[] input) throws ParseException;
034
035    /**
036     * Parses a specified range in a byte array. The specified range is expected to contain
037     * exactly one log event.
038     *
039     * @param input  the byte array
040     * @param offset  the initial offset
041     * @param length  the length
042     *
043     * @return the parsed LogEvent, never {@literal null}.
044     * @throws ParseException if the input is malformed and cannot be parsed as a LogEvent
045     */
046    LogEvent parseFrom(byte[] input, int offset, int length) throws ParseException;
047}