Package com.arc_e_tect.gradle.apionly.transcriberj.spi

package com.arc_e_tect.gradle.apionly.transcriberj.spi

The emitter interface: how a library adds a dialect to the classes the API-Only TranscriberJ generates.

An emitter is a library that implements Emitter and lists its implementation in META-INF/services/com.arc_e_tect.gradle.apionly.transcriberj.spi.Emitter. A project that wants it adds the library to its transcriberjEmitters configuration; the plugin loads it in a class loader of its own and runs it over the contract model, after the built-in core emitter.

The core emitter decides every class name once, in ClassNames, so that a dialect's companion class and the core class it belongs to always agree.

Related Packages

Package	Description
com.arc_e_tect.gradle.apionly.transcriberj	The API-Only TranscriberJ Gradle plugin: generates a contract-derived class tree from a contract the API-Only Subscriber fetched.
com.arc_e_tect.gradle.apionly.transcriberj.core	The built-in core emitter, and the generation run that drives every emitter.
com.arc_e_tect.gradle.apionly.transcriberj.model	The contract model: what a bundled OpenAPI 3 contract says, in the terms code generation needs, and nothing that knows about Java, REST Docs or WireMock.

Class	Description
ClassNames	The core classes of one contract, as the core emitter names them.
Emitter	A dialect of generated code: REST Docs descriptors, WireMock stubs, and the like.
EmitterContext	What an emitter is given to write one contract's classes.
GeneratedClass	One core class, as the core emitter names it.
ManagedDependency	A library generated code needs.
Origin	What a generated class was generated from.
Settings	How a project has asked for one contract's classes to be generated.