io.jstach.rainbowgum.pattern.format.PatternEncoder Maven / Gradle / Ivy

Go to download
package io.jstach.rainbowgum.pattern.format;

import java.util.function.Consumer;

import io.jstach.rainbowgum.LogProvider;
import io.jstach.rainbowgum.LogEncoder;
import io.jstach.rainbowgum.LogEvent;

/**
 * Factory for pattern encoders.
 *
 * @apiNote This class is for API discoverability. Pattern Encoders do not actually extend
 * or implement this class.
 */
public final class PatternEncoder implements LogEncoder {

	/**
	 * Pattern encoder URI provider scheme.
	 */
	public static final String PATTERN_SCHEME = "pattern";

	private PatternEncoder() {
	}

	/**
	 * Creates a pattern encoder with name of the parent component and will use the
	 * properties from the provided config.
	 * @param builder pattern builder
	 * @return provider of the encoder.
	 */
	public static LogProvider of(Consumer builder) {
		return (name, config) -> {
			PatternEncoderBuilder b = new PatternEncoderBuilder(name);
			builder.accept(b);
			b.fromProperties(config.properties());
			return b.build().provide(name, config);
		};
	}

	/**
	 * Pattern encoder builder.
	 * @param name name to use for property resolution.
	 * @return builder.
	 * @apiNote {@link #of(Consumer)} is easier to use at will inherit the name and set
	 * the properties.
	 */
	public static PatternEncoderBuilder builder(String name) {
		return new PatternEncoderBuilder(name);
	}

	@Override
	public Buffer buffer(BufferHints hints) {
		throw new UnsupportedOperationException();
	}

	@Override
	public void encode(LogEvent event, Buffer buffer) {
		throw new UnsupportedOperationException();
	}

}