4PointSolutions / 4PointSolutions/FormsFeeder

Create supporting framework for parsing plugin input parameters

Aperta
#13 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Java
Stelle
4
Fork
3
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Currently, the parsing of inputs to a plugin is always ad-hoc code. This leads to a lot of code duplication and is an impediment to easily creating plugins. It would be nice if there was a declarative approach that could be used instead.

I am thinking of a Builder pattern where one builds a list of input parameters that one expects. Each parameter would have a name, whether it repeats, whether it is optional and a class type. The result would be used by the framework code to decode the input parameters into a result object (the decoded InputParameters object).

Ideally the result object would ideally allow the user to access individual outputs in a strongly typed fashion, however in the worst case scenario, perhaps it could be a Map keyed in each input parameters name.

Another idea would be for the caller to pass in a Java record class that the parsing routine would examine using reflection and use it to get the Input parameters and populate the Record. Each field's name would be used to retrieve parameters. If the field was an Optional<> this would indicate that the parameter was optional. If the field was a Collection of some sort, that would indicate that the parameter could repeat.

A precursor to this is probably implementing issue #12 .

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

First, examine existing plugin implementations to understand the current ad-hoc parsing. Review issue #12 as a precursor. The goal is to design a builder pattern or reflection-based system for declarative input parameter parsing. Start by exploring the plugin interface and how inputs are currently passed. A successful implementation will reduce code duplication and be used by plugin authors.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
backend-api-design
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.