ViewModule.java

/*****************************************************************************
 * Copyright 2011 Zdenko Vrabel
 *
 * 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 org.zdevra.guice.mvc;

import org.zdevra.guice.mvc.MvcModule.NamedViewBindingBuilder;

import com.google.inject.AbstractModule;

/**
 * The module provide a view configuration apart of the main MvcModule.
 * 
 * This is usefull when you will implement your own view extensions or
 * if you want to change view name bindings for testing purpose.  
 *  
 */
public abstract class ViewModule extends AbstractModule {

    private MultibinderBuilder<ViewScanner> viewScannerBuilder;
    private NamedViewBuilder namedViewBudiler;


    /**
     * In this method you will setup your views
     */
    protected abstract void configureViews();


    /**
     * {@inheritDoc}
     */
    @Override
    protected final void configure() {
        viewScannerBuilder = new MultibinderBuilder<ViewScanner>(binder(), ViewScanner.class);
        namedViewBudiler = new NamedViewBuilder(binder());
        try {
            requireBinding(ViewResolver.class);
            requireBinding(ViewScannerService.class);
            configureViews();
        } finally {
            viewScannerBuilder = null;
            namedViewBudiler = null;
        }
    }


    /**
     * The method register into {@link ViewScannerService} a custom
     * view scanner as a class
     * 
     * @see ViewScannerService
     */
    protected final void registerViewScanner(Class<? extends ViewScanner> scannerClass) {
        this.viewScannerBuilder.registerClass(scannerClass);
    }


    /**
     * The method register into {@link ViewScannerService} a custom
     * view scanner as a instance.
     * 
     * @see ViewScannerService
     */
    protected final void registerViewScanner(ViewScanner scannerInstance) {
        this.viewScannerBuilder.registerInstance(scannerInstance);
    }


    /**
     * Method bind to view's name some view.
     */
    protected final NamedViewBindingBuilder bindViewName(String viewName) {
        return this.namedViewBudiler.bindViewName(viewName);
    }
}