/**
*
* 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 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 <M> The model type
* @see Transform
*/
public interface HasJavadocView<M extends HasJavadoc<M>> extends
Transform<M, String> {
/**
* 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("");
}
}