com.fluxtion.agrona.generation.OutputManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of runtime Show documentation

The newest version!

/*
 * Copyright 2014-2024 Real Logic Limited.
 *
 * 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
 *
 * https://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.fluxtion.agrona.generation;

import com.fluxtion.agrona.LangUtil;

import java.io.IOException;
import java.io.Writer;

/**
 * Abstraction that manages the destination of generated output.
 */
public interface OutputManager
{
    /**
     * Create a new output destination based on a name. The user is responsible for calling
     * {@link java.io.Writer#close()}.
     *
     * @param name of the given output.
     * @return A {@link Writer} to which the code generation should be output.
     * @throws IOException if an error occurs during output.
     */
    Writer createOutput(String name) throws IOException;

    /**
     * Create named output and call {@link ResourceConsumer#accept(Object)}.
     *
     * @param name             name of the output to create.
     * @param resourceConsumer to be called.
     */
    default void withOutput(final String name, final ResourceConsumer resourceConsumer)
    {
        try (Writer output = createOutput(name))
        {
            resourceConsumer.accept(output);
        }
        catch (final IOException ex)
        {
            LangUtil.rethrowUnchecked(ex);
        }
    }
}