Common/src/com/googlecode/android_scripting/rpc/Rpc.java

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * 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.googlecode.android_scripting.rpc;

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

/**
 * The {@link Rpc} annotation is used to annotate server-side implementations of RPCs. It describes
 * meta-information (currently a brief documentation of the function), and marks a function as the
 * implementation of an RPC.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Rpc {
  /**
   * Returns brief description of the function. Should be limited to one or two sentences.
   */
  String description();

  /**
   * Gives a brief description of the functions return value (and the underlying data structure).
   */
  String returns() default "";
}