|
38 | 38 | public @interface ImportGrpcClients { |
39 | 39 |
|
40 | 40 | /** |
41 | | - * The name or base URL of the gRPC server to connect to. If not specified, the client |
| 41 | + * The name or base URL of the gRPC server to connect to. If not specified, the |
| 42 | + * client |
42 | 43 | * will connect to the default server. |
| 44 | + * |
43 | 45 | * @return the name or base URL of the server |
44 | 46 | */ |
45 | 47 | String target() default "default"; |
46 | 48 |
|
47 | 49 | /** |
48 | | - * The prefix to use when creating bean definitions for clients, completed by the |
49 | | - * simple name of the class. Default is empty. You only need to specify a value if you |
50 | | - * define more than one client of the same type (or with types that have the same name |
| 50 | + * The prefix to use when creating bean definitions for clients, completed by |
| 51 | + * the |
| 52 | + * simple name of the class. Default is empty. You only need to specify a value |
| 53 | + * if you |
| 54 | + * define more than one client of the same type (or with types that have the |
| 55 | + * same name |
51 | 56 | * in different packages). |
| 57 | + * |
52 | 58 | * @return the prefix |
53 | 59 | */ |
54 | 60 | String prefix() default ""; |
55 | 61 |
|
56 | 62 | /** |
57 | 63 | * Concrete types of the stubs to create. |
| 64 | + * |
58 | 65 | * @return the types of the stubs |
59 | 66 | */ |
60 | 67 | Class<?>[] types() default {}; |
61 | 68 |
|
62 | 69 | /** |
63 | | - * The factory type to use to create the stubs. Only needed if you are scanning (with |
64 | | - * basePackageClasses or basePackages) and you need to customize the stub creation. |
| 70 | + * The factory type to use to create the stubs. Only needed if you are scanning |
| 71 | + * (with |
| 72 | + * basePackageClasses or basePackages) and you need to customize the stub |
| 73 | + * creation. |
| 74 | + * |
65 | 75 | * @return the factory type, default is {@link BlockingStubFactory} |
66 | 76 | */ |
67 | 77 | Class<? extends StubFactory<?>> factory() default UnspecifiedStubFactory.class; |
68 | 78 |
|
69 | 79 | /** |
70 | 80 | * The base package classes to scan for stub implementations. If not specified, |
71 | 81 | * scanning will be done from the package of the class with this annotation. |
| 82 | + * When a stub is found, a client bean will be created for it using the |
| 83 | + * configured |
| 84 | + * {@link #factory()}. |
| 85 | + * |
72 | 86 | * @return the base package classes for scanning |
73 | 87 | */ |
74 | 88 | Class<?>[] basePackageClasses() default {}; |
75 | 89 |
|
76 | 90 | /** |
77 | | - * The base packages to scan for stub implementations. |
| 91 | + * The base packages to scan for stub implementations. When a stub is found, a |
| 92 | + * client bean will be created for it using the configured |
| 93 | + * {@link #factory()}. |
| 94 | + * |
78 | 95 | * @return the base packages for scanning |
79 | 96 | */ |
80 | 97 | String[] basePackages() default {}; |
|
0 commit comments