com.canoo.platform.remoting.server.Param Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dolphin-platform-remoting-server Show documentation

The Dolphin Platform is a framework that implements the presentation model pattern and provides amodern way to create enterprise applications. The Platform provides several client implementations that all canbe used in combination with a general sever API.

The newest version!

/*
 * Copyright 2015-2018 Canoo Engineering AG.
 *
 * Licensed 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.canoo.platform.remoting.server;

import org.apiguardian.api.API;

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

import static java.lang.annotation.RetentionPolicy.RUNTIME;
import static org.apiguardian.api.API.Status.MAINTAINED;

/**
 * 
 * When defining a controller method by using {@link RemotingAction} the
 * Dolphin Platform supports methods parameters. The parameters can be set on the client when calling
 * the action method. To define parameters o the server controller method each paramter must be annotated
 * with the {@link Param} annotation.
 *
 * 
 * Example:
 *
 * 

 *  *     {@literal @}RemotingController("my-controller")
 *     public class MyController {
 *
 *         {@literal @}RemotingAction("my-action")
 *         private void showById(@Param("id") id) { . . . };
 *     }
 * 
 * 
 *
 *
 * @author Hendrik Ebbers
 * @see RemotingAction
 */
@Documented
@Retention(RUNTIME)
@Target(ElementType.PARAMETER)
@API(since = "0.x", status = MAINTAINED)
public @interface Param {

    /**
     * The name of the param
     * @return the name
     */
    String value() default "";

}