eclipse-vertx / eclipse-vertx/vertx-codegen

Extend Map returns to supports more types than basic and json (enums, etc...)

オープン
#90 コメント 12 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Java
スター
111
フォーク
88
PR マージ指標
30日以内にマージされた PR はありません

説明

The following proxy interface doesn't compile:

``` java
package com.melusyn.gatekeeper.service;

import io.vertx.codegen.annotations.ProxyGen;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

import java.util.Map;

/**
* The service interface.
*/
@ProxyGen
@VertxGen // Generate the proxy and handler
public interface MyProxyService {

enum MyEnum {
Value1,
Value2,
Value3,
}

void callThatReturnsAMap(String param1, Handler>> handler);
}
```

The compilation fails with the error:

```
type >> is not legal for use for a parameter in proxy
```

However, the documentation says otherwise (https://github.com/vert-x3/vertx-codegen#permitted-types).

> The following set R of types are permitted as return types from any API method:
> [...]
> type java.util.List, java.util.Set or java.util.Map where C contains
> [...]

The method `io.vertx.codegen.ProxyModel.isLegalListSetMapResult` does not check for `Map` type.

Has this been overlooked or this is on purpose? I found an old issue #8 referring to it... But not much was said at that time.

I'm willing to do a PR if the core team feel this is missing and should been implemented.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

io.vertx.codegen.ProxyModel.isLegalListSetMapResult から始め、issue の MyProxyService の例を再現します。その動作を許可されている型のドキュメントと比較します。Map の proxy メソッドが、ドキュメントに記載されたサポート対象の型と一貫して処理されれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
tooling
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。