com.opensymphony.xwork2.interceptor.annotations.InputConfig Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.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;
}