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.parser;
18
19 import org.apache.logging.log4j.core.LogEvent;
20
21 /**
22 * Parse the output from a layout into instances of {@link LogEvent}.
23 */
24 public interface LogEventParser {
25 /**
26 * Parses a byte array, which is expected to contain exactly one log event.
27 *
28 * @param input the byte array
29 *
30 * @return the parsed LogEvent, never {@literal null}.
31 * @throws ParseException if the input is malformed and cannot be parsed as a LogEvent
32 */
33 LogEvent parseFrom(byte[] input) throws ParseException;
34
35 /**
36 * Parses a specified range in a byte array. The specified range is expected to contain
37 * exactly one log event.
38 *
39 * @param input the byte array
40 * @param offset the initial offset
41 * @param length the length
42 *
43 * @return the parsed LogEvent, never {@literal null}.
44 * @throws ParseException if the input is malformed and cannot be parsed as a LogEvent
45 */
46 LogEvent parseFrom(byte[] input, int offset, int length) throws ParseException;
47 }