org.beangle.webmvc.api.annotation.view Maven / Gradle / Ivy

Go to download
/*
 * Beangle, Agile Development Scaffold and Toolkits.
 *
 * Copyright © 2005, The Beangle Software.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package org.beangle.webmvc.api.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
public @interface view {
  /**
   * @return The name of the result mapping. This is the value that is
   *         returned from the action method and is used to associate a
   *         location with a return value.
   */
  String name() default "success";;

  /**
   * @return The location of the result within the web application or anywhere
   *         on disk.
   */
  String location() default "";

  /**
   * @return The type of the result.
   */
  String type() default "";

  /**
   * @return The parameters passed to the result. This is a list of strings
   *         that form a name/value pair chain since creating a Map for
   *         annotations is not possible. An example would be:
   *         {"key", "value", "key2", "value2"}.
   */
  String[] params() default {};
}