com.gwtplatform.dispatch.rest.rebind.AbstractVelocityGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwtp-dispatch-rest Show documentation
There is a newer version: 1.6
/**
 * Copyright 2013 ArcBees Inc.
 *
 * 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.gwtplatform.dispatch.rest.rebind;

import java.io.PrintWriter;

import javax.inject.Provider;
import javax.ws.rs.Path;

import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;

import com.google.gwt.core.ext.UnableToCompleteException;
import com.google.gwt.core.ext.typeinfo.HasAnnotations;
import com.google.gwt.core.ext.typeinfo.TypeOracle;
import com.gwtplatform.dispatch.rest.rebind.util.GeneratorUtil;

public abstract class AbstractVelocityGenerator {
    protected static final String SUFFIX = "Impl";
    protected static final String SHARED_PACKAGE = "shared";
    protected static final String CLIENT_PACKAGE = "client";

    private final TypeOracle typeOracle;
    private final Logger logger;
    private final Provider velocityContextProvider;
    private final VelocityEngine velocityEngine;
    private final GeneratorUtil generatorUtil;

    protected AbstractVelocityGenerator(
            TypeOracle typeOracle,
            Logger logger,
            Provider velocityContextProvider,
            VelocityEngine velocityEngine,
            GeneratorUtil generatorUtil) {
        this.typeOracle = typeOracle;
        this.logger = logger;
        this.velocityContextProvider = velocityContextProvider;
        this.velocityEngine = velocityEngine;
        this.generatorUtil = generatorUtil;
    }

    protected GeneratorUtil getGeneratorUtil() {
        return generatorUtil;
    }

    protected Logger getLogger() {
        return logger;
    }

    protected TypeOracle getTypeOracle() {
        return typeOracle;
    }

    protected void mergeTemplate(PrintWriter printWriter, String velocityTemplate, String implName)
            throws UnableToCompleteException {
        VelocityContext velocityContext = velocityContextProvider.get();
        velocityContext.put("lf", "\n");
        velocityContext.put("implName", implName);
        velocityContext.put("package", getPackage());

        populateVelocityContext(velocityContext);

        velocityEngine.mergeTemplate(velocityTemplate, "UTF-8", velocityContext, printWriter);
        generatorUtil.closeDefinition(printWriter);
    }

    protected abstract String getPackage();

    protected abstract void populateVelocityContext(VelocityContext velocityContext) throws UnableToCompleteException;

    protected String extractPath(HasAnnotations type) {
        String path = "";

        if (type.isAnnotationPresent(Path.class)) {
            path = normalizePath(type.getAnnotation(Path.class).value());
        }

        return path;
    }

    protected String concatenatePath(String prefix, String suffix) {
        String normalizerPrefix = normalizePath(prefix);
        String normalizedSuffix = normalizePath(suffix);

        if (normalizerPrefix.endsWith("/") && !normalizedSuffix.isEmpty()) {
            normalizedSuffix = normalizedSuffix.substring(1);
        }

        return normalizerPrefix + normalizedSuffix;
    }

    protected String normalizePath(String path) {
        String normalizedPath = path;
        if (!path.isEmpty() && !path.startsWith("/") && !path.startsWith("http://") && !path.startsWith("https://")) {
            normalizedPath = "/" + path;
        }

        return normalizedPath;
    }
}