com.speedment.common.codegen.internal.java.view.trait.HasJavadocView Maven / Gradle / Ivy

Go to download

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

An object-oriented code generator for Java that is built using the Model-View-Controller (MVC) design philosophy.

There is a newer version: 3.2.10

/**
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * 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 com.speedment.common.codegen.internal.java.view.trait;

import com.speedment.common.codegen.Generator;
import com.speedment.common.codegen.Transform;
import com.speedment.common.codegen.model.trait.HasJavadoc;

import static com.speedment.common.codegen.util.Formatting.nl;

/**
 * A trait with the functionality to render models with the trait 
 * {@link HasJavadoc}.
 * 
 * @author     Emil Forslund
 * @param   The model type
 * @see        Transform
 */
public interface HasJavadocView> extends 
    Transform {
    
    /**
     * Render the javadoc-part of the model with an extra new-line appended
     * afterwards. If no javadoc exists, an empty string is returned.
     * 
     * @param gen    the generator
     * @param model  the model
     * @return       the generated code
     */
    default String renderJavadoc(Generator gen, M model) {
        return gen.on(model.getJavadoc())
            .map(doc -> doc + nl())
            .orElse("");
    }
}