Package com.arc_e_tect.gradle.apionly.transcriberj

Class ApiOnlyTranscriberJExtension

java.lang.Object

com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJExtension

public abstract class ApiOnlyTranscriberJExtension
extends Object

The apiOnlyTranscriberJ block: which subscribed contracts get a generated class tree, and how.

 apiOnlyTranscriberJ {
     subscription('orders') {
         basePackage = 'com.example.orders.contract'
     }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name the extension is registered under.

Constructor Summary

Constructors

Constructor	Description
ApiOnlyTranscriberJExtension(org.gradle.api.model.ObjectFactory objects)	Creates the extension.

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.provider.Property<Boolean>	getStrictDependencies()	Whether a dependency version an emitter was not tested with fails the build, rather than only being warned about.
org.gradle.api.NamedDomainObjectContainer<TranscriberJSubscription>	getSubscriptions()	Every contract classes are generated for.
TranscriberJSubscription	subscription(String contract, org.gradle.api.Action<? super TranscriberJSubscription> action)	Generates classes for a contract the apiOnlySubscriber block subscribes to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

The name the extension is registered under.

See Also:

• Constant Field Values

Constructor Details

ApiOnlyTranscriberJExtension

@Inject
public ApiOnlyTranscriberJExtension(org.gradle.api.model.ObjectFactory objects)

Creates the extension.

Parameters:

objects - Gradle's object factory

Method Details

getStrictDependencies

public abstract org.gradle.api.provider.Property<Boolean> getStrictDependencies()

Whether a dependency version an emitter was not tested with fails the build, rather than only being warned about.

Default: false.

Returns:

the setting

getSubscriptions

public org.gradle.api.NamedDomainObjectContainer<TranscriberJSubscription> getSubscriptions()

Every contract classes are generated for.

Returns:

the subscriptions

subscription

public TranscriberJSubscription subscription(String contract,
 org.gradle.api.Action<? super TranscriberJSubscription> action)

Generates classes for a contract the apiOnlySubscriber block subscribes to.

Parameters:

contract - the contract's name, as subscribed

action - how its classes are generated

Returns:

the settings