1/* 2 * Copyright (C) 2016 Google Inc. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 5 * use this file except in compliance with the License. You may obtain a copy of 6 * the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 * License for the specific language governing permissions and limitations under 14 * the License. 15 */ 16 17package com.googlecode.android_scripting.rpc; 18 19import java.lang.annotation.Documented; 20import java.lang.annotation.ElementType; 21import java.lang.annotation.Retention; 22import java.lang.annotation.RetentionPolicy; 23import java.lang.annotation.Target; 24 25/** 26 * The {@link Rpc} annotation is used to annotate server-side implementations of RPCs. It describes 27 * meta-information (currently a brief documentation of the function), and marks a function as the 28 * implementation of an RPC. 29 */ 30@Retention(RetentionPolicy.RUNTIME) 31@Target(ElementType.METHOD) 32@Documented 33public @interface Rpc { 34 /** 35 * Returns brief description of the function. Should be limited to one or two sentences. 36 */ 37 String description(); 38 39 /** 40 * Gives a brief description of the functions return value (and the underlying data structure). 41 */ 42 String returns() default ""; 43} 44