Arg.java

/*
 * JSmart Framework - Java Web Development Framework
 * Copyright (c) 2015, Jeferson Albino da Silva, All rights reserved.
 *
 * This library 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.0 of the License, or (at your option) any later version.
 *
 * This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*/

package com.jsmartframework.web.annotation;

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

/**
 * This annotation is used along with {@link Function} annotation
 * to specify the arguments which JavaScript function call may receive.
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Arg {

    /**
     * Specify the name of the argument.
     * It accepts Expression language and/or text values.
     */
    String name() default "";

    /**
     * Specify the value for the argument, case bindTo attribute is specified the value is ignored.
     * It accepts Expression language and/or text values.
     */
    String value() default "";

    /**
     * Id of HTML input element to bind to, so when Ajax request is executed
     * the framework will capture the value of specified component and carry it
     * along with the request as method argument.
     */
    String bindTo() default "";
}