org.directwebremoting.annotations.RemoteProxy Maven / Gradle / Ivy

Go to download
package org.directwebremoting.annotations;

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

import org.directwebremoting.create.NewCreator;
import org.directwebremoting.extend.Creator;

/**
 * Make a class available for remote access.
 * @author Maik Schreiber [blizzy AT blizzy DOT de]
 * @author Joe Walker [joe at getahead dot ltd dot uk]
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface RemoteProxy
{
    /**
     * Name of the JavaScript variable (default: the simple class name without package).
     * @return ...
     */
    String name() default "";

    /**
     * Creator that creates instances of the class (default: "{@code new}" creator).
     * @return ...
     */
    Class creator() default NewCreator.class;

    /**
     * Parameters for the creator.
     * @return ...
     */
    Param[] creatorParams() default {};

    /**
     * Scope of the JavaScript variable (default: PAGE).
     * @return ...
     */
    ScriptScope scope() default ScriptScope.PAGE;
}