com.github.edgarespina.mwa.view.ModelContribution Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mwa-view Show documentation

The newest version!

package com.github.edgarespina.mwa.view;

import java.io.IOException;
import java.util.Map;

import javax.servlet.ServletContext;

/**
 * Provide additional models attributes to a view.
 *
 * @author edgar.espina
 * @since 0.1
 * @see ModernView
 */
public interface ModelContribution {

  /**
   * Store the view's name in the model.
   */
  String VIEW = "viewName";

  /**
   * Store the context path variable in the model.
   */
  String CONTEXT_PATH = "contextPath";

  /**
   * Called once during initialization.
   *
   * @param context The servlet context. It's never null.
   * @throws IOException If something goes wrong.
   */
  void init(ServletContext context) throws IOException;

  /**
   * Add new model attributes to the view.
   *
   * @param view The view's name. It never nulls.
   * @param model The model. It never nulls.
   * @throws IOException If something goes wrong.
   */
  void contribute(String view, Map model) throws IOException;

  /**
   * Enabled or disable the cache. Useful for dev and no-dev environments.
   *
   * @param cache True for enable the cache.
   */
  void setUseCache(boolean cache);
}