Package org.apache.logging.log4j.core.parser

Interface LogEventParser

All Known Subinterfaces:
TextLogEventParser
All Known Implementing Classes:
JsonLogEventParser, XmlLogEventParser, YamlLogEventParser
public interface LogEventParser
Parse the output from a layout into instances of LogEvent.

  • Method Summary

    Modifier and Type
    Method
    Description
    LogEvent
    parseFrom(byte[] input)
    Parses a byte array, which is expected to contain exactly one log event.
    LogEvent
    parseFrom(byte[] input, int offset, int length)
    Parses a specified range in a byte array.

  • Method Details

    • parseFrom

      LogEvent parseFrom(byte[] input) throws ParseException
      Parses a byte array, which is expected to contain exactly one log event.
      Parameters:
      input - the byte array
      Returns:
      the parsed LogEvent, never null.
      Throws:
      ParseException - if the input is malformed and cannot be parsed as a LogEvent

    • parseFrom

      LogEvent parseFrom(byte[] input, int offset, int length) throws ParseException
      Parses a specified range in a byte array. The specified range is expected to contain exactly one log event.
      Parameters:
      input - the byte array
      offset - the initial offset
      length - the length
      Returns:
      the parsed LogEvent, never null.
      Throws:
      ParseException - if the input is malformed and cannot be parsed as a LogEvent