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

Go to download
/*
 * Copyright (c) 2023, 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 static io.helidon.codegen.CodegenUtil.capitalize;

/**
 * Scope of the current code generation session.
 *
 * @param name name of the scope, use empty string for production scope, see {@link #PRODUCTION}, use lower case names
 */
public record CodegenScope(String name) {
    /**
     * Production scope.
     */
    public static final CodegenScope PRODUCTION = new CodegenScope("");

    /**
     * Whether this is a production scope.
     *
     * @return if production
     */
    public boolean isProduction() {
        return name.isBlank();
    }

    /**
     * Type prefix for this scope.
     *
     * @return the scope name with first letter as capital
     */
    public String prefix() {
        if (isProduction()) {
            return name;
        }
        return capitalize(name);
    }
}