net.logstash.logback.pattern.NodeWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of logstash-logback-encoder Show documentation

Provides logback encoders, layouts, and appenders to log in JSON and other formats supported by Jackson

There is a newer version: 8.0

Show newest version

/*
 * Copyright 2013-2022 the original author or authors.
 *
 * 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 net.logstash.logback.pattern;

import java.io.IOException;

import com.fasterxml.jackson.core.JsonGenerator;

/**
 * Writes a JSON pattern node into JSON generator supplied.
 *
 * @param  - type of the event (ILoggingEvent, IAccessEvent)
 *
 * @author Dmitry Andrianov
 */
public interface NodeWriter {
    /**
     * Writes this node to the given generator.
     * 
     * @param generator the generator to which to write the node
     * @param event the event from which to get data to write
     * @throws IOException if an I/O error occurs
     */
    void write(JsonGenerator generator, Event event) throws IOException;
}