com.github.palindromicity.syslog.SyslogParser Maven / Gradle / Ivy
/*
* Copyright 2018-2022 simple-syslog authors
* All rights reserved.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.palindromicity.syslog;
import java.io.Reader;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import org.jspecify.nullness.NullMarked;
/**
* {@code SyslogParser} defines an interface for classes that parse Syslog into {@code Map}.
*/
@NullMarked
public interface SyslogParser {
/**
* Parse a {@code String} to a {@code T}.
*
* @param line the line of Syslog to parse
* @return a {@code T}
* @throws com.github.palindromicity.syslog.dsl.ParseException if there is an error parsing
*/
T parseLine(String line);
/**
* Parse a {@code String} to a {@code Map} and provides that {@code T}
* to the provided {@code Consumer}.
*
* @param line the line of Syslog to parser
* @param consumer the {@code Consumer}
* @throws com.github.palindromicity.syslog.dsl.ParseException if there is an error parsing
*/
void parseLine(String line, Consumer consumer);
/**
* Reads each line from the {@code Reader} and parses it to a {@code List} of {@code T}.
*
* @param reader {@code Reader} used. It is not closed in this method.
* @return {@code List} of {@code Map}
* @throws com.github.palindromicity.syslog.dsl.ParseException if there is an error parsing
* @throws IllegalArgumentException if reader is null
*/
List parseLines(Reader reader);
/**
* Reads each line from the {@code Reader} and parses it to {@code T}, which is passed to the
* provided {@code Consumer}.
*
* @param reader {@code Reader} used. It is not closed in this method.
* @param consumer the {@code Consumer}
* @throws com.github.palindromicity.syslog.dsl.ParseException if there is an error parsing
* @throws IllegalArgumentException if reader or consumer are null
*/
void parseLines(Reader reader, Consumer consumer);
/**
* Reads each line from the {@code Reader} and parses it to {@code T}, which is passed to the
* provided {@code Consumer}. For any line where a {@code ParseException} would be thrown, it will
* will be passed to the errorConsumer.
*
* @param reader {@code Reader} used. It is not closed in this method.
* @param messageConsumer the {@code Consumer} for messages
* @param errorConsumer the {@code Consumer} for syslog lines and their errors.
* @throws IllegalArgumentException if reader, messageConsumer, or errorConsumer are null
*/
void parseLines(Reader reader, Consumer messageConsumer,
BiConsumer errorConsumer);
}