com.speedment.common.codegen.internal.java.view.FileView 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-2016, 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;

import com.speedment.common.codegen.DependencyManager;
import com.speedment.common.codegen.Generator;
import com.speedment.common.codegen.Transform;
import com.speedment.common.codegen.internal.java.view.trait.HasClassesView;
import com.speedment.common.codegen.internal.java.view.trait.HasImportsView;
import com.speedment.common.codegen.internal.java.view.trait.HasJavadocView;
import com.speedment.common.codegen.model.File;
import com.speedment.common.codegen.util.Formatting;

import java.util.Optional;

import static com.speedment.common.codegen.internal.util.NullUtil.requireNonNulls;
import static com.speedment.common.codegen.util.Formatting.*;

/**
 * Transforms from a {@link File} to java code.
 * 
 * @author Emil Forslund
 */
public final class FileView implements Transform, 
        HasImportsView,    
        HasJavadocView, 
        HasClassesView {
    
    /**
     * {@inheritDoc}
     */
	@Override
	public Optional transform(Generator gen, File model) {
        requireNonNulls(gen, model);
        
		final DependencyManager mgr = gen.getDependencyMgr();
        mgr.clearDependencies();
        
        final String pack = fileToClassName(model.getName())
            .flatMap(Formatting::packageName)
            .orElse("");
        
        mgr.setCurrentPackage(pack);

		final Optional view = Optional.of(
			renderJavadoc(gen, model) +
			renderPackage(model) +
            renderImports(gen, model) +
            renderClasses(gen, model)
		);
		
		mgr.unsetCurrentPackage(pack);
		
		return view;
	}
    
    /**
     * Renders the 'package'-part of the file. In java, the package should only
     * be present if the file is located in a directory in the sources folder.
     * If the file is in the global package, an empty string will be returned.
     * 
     * The package part will be suffixed by two new line characters if a package
     * was outputted.
     * 

     * Example: 
"package com.speedment.example;\n\n"
     * 
     * @param file  the file
     * @return      the package part or an empty string
     */
    private String renderPackage(File file) {
		final Optional name = fileToClassName(file.getName());
		if (name.isPresent()) {
			final Optional pack = packageName(name.get());
			if (pack.isPresent()) {
				return "package " + pack.get() + ";" + dnl();
			}
		}
		
		return "";
	}
}