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

Go to download
/*
 * Copyright 2013-2023 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;

/**
 * Computes a value given an event.
 *
 * @param  - type of the computed value
 * @param  - type of the event (ILoggingEvent, IAccessEvent)
 *
 * @author Dmitry Andrianov
 */
public interface ValueGetter {
    /**
     * Get the result of applying the ValueGetter to the event
     * 
     * @param event the event to apply this ValueGetter
     * @return the result of applying this ValueGetter on the event
     */
    T getValue(Event event);
}