com.opensymphony.xwork2.interceptor.annotations.InputConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwork Show documentation

XWork is an command-pattern framework that is used to power WebWork as well as other applications. XWork provides an Inversion of Control container, a powerful expression language, data type conversion, validation, and pluggable configuration.

There is a newer version: 2.1.3

Show newest version

/*
 * Copyright (c) 2002-2008 by OpenSymphony
 * All rights reserved.
 */
package com.opensymphony.xwork2.interceptor.annotations;

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

import com.opensymphony.xwork2.Action;

/**
 * 
 * Marks a action method that if it's not validated by ValidationInterceptor then execute input method or input result.
 * 
 *
 *  Annotation usage:
 *
 * 
 * The InputConfig annotation can be applied at method level.
 *
 * 
 *
 * 
 Annotation parameters:
 *
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 *  Parameter  Required  Default  Notes 
methodName no execute this method if specific
resultName no return this result if methodName not specific
 * 
 *
 *  Example code:
 *
 * 
 * 
 * public class SampleAction extends ActionSupport {
 *
 *  public void isValid() throws ValidationException {
 *    // validate model object, throw exception if failed
 *  }
 *
 *  @InputConfig(methodName="input")
 *  public String execute() {
 *     // perform action
 *     return SUCCESS;
 *  }
 *  public String input() {
 *     // perform some data filling
 *     return INPUT;
 *  }
 * }
 * 
 * 
 *
 * @author zhouyanming, [email protected]
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface InputConfig {
    String methodName() default "";
    String resultName() default Action.INPUT;
}

Parameter	Required	Default	Notes
methodName	no		execute this method if specific
resultName	no		return this result if methodName not specific