HasJavadocTagsView.java

/**
 *
 * Copyright (c) 2006-2017, 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 com.speedment.common.codegen.model.trait.HasJavadocTags;

import java.util.stream.Stream;

/**
 * A trait with the functionality to render models with the trait 
 * {@link HasJavadoc}.
 * 
 * @author     Emil Forslund
 * @param <M>  The model type
 * @see        Transform
 */
public interface HasJavadocTagsView<M extends HasJavadocTags<M>> {
    
    /**
     * Returns a stream of javadoc lines generated from the tags in the
     * specified model. If the stream is not empty it is prepended by an
     * empty line.
     * 
     * @param gen    the generator
     * @param model  the model
     * @return       the generated code
     */
    default Stream<String> renderJavadocTags(Generator gen, M model) {
        final Stream<String> stream = gen.onEach(model.getTags());
        
        if (model.getTags().isEmpty()) {
            return stream;
        } else {
            return Stream.concat(
                Stream.of(" "), // to get an empty line before the tags...
                stream
            );
        }
    }
}