io.helidon.codegen.FilerTextResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of helidon-codegen Show documentation

Code generation common utilities

The newest version!

/*
 * Copyright (c) 2024 Oracle and/or its affiliates.
 *
 * 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 io.helidon.codegen;

import java.util.List;

/**
 * A resource from output (such as {@code target/META-INF/helidon}) that can have existing
 * values, and may be replaced with a new value.
 */
public interface FilerTextResource {
    /**
     * Existing lines of the resource. Returns an empty list if the resource does not exist.
     *
     * @return list of lines, immutable collection
     */
    List lines();

    /**
     * New lines of the resource.
     *
     * @param newLines new lines to {@link #write()} to the resource file
     */
    void lines(List newLines);

    /**
     * Writes the new lines to the output. This operation can only be called once per codegen round.
     */
    void write();
}