Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

action() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the action record component.

add(GenerationReport) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Adds what one emitter reported -- the methods it degraded -- after everything already here, as a run of every emitter in one pass would have.

ADDITIONAL_PROPERTIES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

additionalProperties, in any of its forms.

additionalProperties() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the additionalProperties record component.

AdditionalProperties - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

The value of additionalProperties: a boolean, or a schema.

AdditionalProperties(Boolean, Schema) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.AdditionalProperties

Creates an instance of a AdditionalProperties record class.

address() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the address record component.

advice() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Recommendation

Returns the value of the advice record component.

all() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.ClassNames

Every core class, in the order the contract declares what they come from.

allOf() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the allOf record component.

allowed() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AdditionalProperties

Returns the value of the allowed record component.

annotations() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the annotations record component.

ANY_OF_INLINE_BRANCHES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

anyOf with at least one anonymous, inline branch.

ANY_OF_REF_BRANCHES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

anyOf whose branches are all references to components.

anyOf() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the anyOf record component.

ApiOnlyTranscriberJExtension - Class in com.arc_e_tect.gradle.apionly.transcriberj

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

ApiOnlyTranscriberJExtension(ObjectFactory) - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJExtension

Creates the extension.

ApiOnlyTranscriberJPlugin - Class in com.arc_e_tect.gradle.apionly.transcriberj

The API-Only TranscriberJ: a class tree derived from a subscribed contract, for contract tests and stubs.

ApiOnlyTranscriberJPlugin(SoftwareComponentFactory) - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

Creates the plugin.

apply(Project) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

applyCleanupDsl(boolean) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

Sets UpdateApiOnlyTranscriberJDslTask.getCleanupDsl() for this run.

applyGenerateDsl(boolean) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

Sets UpdateApiOnlyTranscriberJDslTask.getGenerateDsl() for this run.

ASYNC_OPERATION - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

An operation of that document: an application sending or receiving on a channel.

AsyncChannel - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A channel of an AsyncAPI contract: an address messages travel over.

AsyncChannel(String, Provenance, String, String, String, List<AsyncMessage>, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Creates an instance of a AsyncChannel record class.

AsyncMessage - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A message a channel carries, as an AsyncAPI bundle inlines it.

AsyncMessage(String, Provenance, String, String, String, String, Component, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Creates an instance of a AsyncMessage record class.

AsyncOperation - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

An operation of an AsyncAPI contract: an application sending or receiving on a channel.

AsyncOperation(String, String, String, List<String>, String, String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Creates an instance of a AsyncOperation record class.

asyncOperations() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the asyncOperations record component.

asyncTitle() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the asyncTitle record component.

available() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Whether the core could build this body.

B

basePackage() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the basePackage record component.

body() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the body record component.

Body(String, String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Creates an instance of a Body record class.

bodyClass() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Returns the value of the bodyClass record component.

bodyShaped() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the bodyShaped record component.

BOOLEAN_SCHEMA - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

A schema written as the literal true or false.

C

CanonicalJson - Class in com.arc_e_tect.gradle.apionly.transcriberj.model

RFC 8785, the JSON Canonicalization Scheme, over the maps, lists and scalars a YAML or JSON parser produces.

CaseKind - Enum Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

What a contract case tests: which response the contract declares for its request, and so what a target must do before the request is sent.

CHANNEL - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A channel of the contract's AsyncAPI document: an address messages travel over.

channelKey() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the channelKey record component.

channels() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the channels record component.

className() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Returns the value of the className record component.

className() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Returns the value of the className record component.

className() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Returns the value of the className record component.

ClassNames - Interface in com.arc_e_tect.gradle.apionly.transcriberj.spi

The core classes of one contract, as the core emitter names them.

com.arc_e_tect.gradle.apionly.transcriberj - package 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 - package 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 - package 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.

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.

component(Origin, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.ClassNames

The class for a component.

component(String) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

The schema component with the given name.

Component - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A schema component.

Component(String, Provenance, Schema, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Creates an instance of a Component record class.

components() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the components record component.

Const - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

The value of a const keyword.

Const(Object) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Const

Creates an instance of a Const record class.

constraintCoverage() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

How many constraints on request input have a case, and how many have none, by reason.

constraints() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the constraints record component.

Constraints - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A schema's validation keywords.

Constraints(Number, Number, String, Number, Number, Object, Object, Number, Number, Number, Boolean, Number, Number) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Creates an instance of a Constraints record class.

construct() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Returns the value of the construct record component.

Construct - Enum Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A construct the model classifies wherever it occurs, so that its treatment in generated code is reported rather than discovered.

constValue() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the constValue record component.

content() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns the value of the content record component.

content() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns the value of the content record component.

contentType() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the contentType record component.

contentType() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Returns the value of the contentType record component.

contentType() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the contentType record component.

contract() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the contract record component.

CONTRACT_CASES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

The contract cases of an operation: its success, not-found, not-acceptable, unsupported-media-type and invalid-request cases.

ContractCase - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

One contract case, as an emitter is given it: the values the generated ContractCase of the base package holds, and the case's index in its operation's CASES.

ContractCase(String, CaseKind, boolean, String, String, String, String, String, String, ContractRequest, int, List<String>, String, String, List<String>, List<String>, int) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

A case, with its lists copied so that they cannot change.

contractCases(String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.ClassNames

The class that lists an operation's contract cases, such as InitiateUserRegistrationContractCases: generated for every operation, with no cases where the contract gives nothing to derive one from.

contractCases(String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

The contract cases of an operation, in the order its generated CASES lists them: success, not found, not acceptable, unsupported media type, then invalid requests.

ContractModel - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A bundled contract, in the terms code generation needs: its OpenAPI document, and its AsyncAPI document where it has one, as one model.

ContractModel(String, String, String, String, List<Component>, List<Reusable<Response>>, List<Reusable<Parameter>>, List<Reusable<RequestBody>>, Map<String, Object>, List<PathItem>, List<AsyncChannel>, List<AsyncOperation>, List<Finding>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Creates an instance of a ContractModel record class.

ContractModelException - Exception Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A document that is not a bundled OpenAPI 3 contract the model can be built from.

ContractModelException(String, Throwable) - Constructor for exception class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModelException

Creates the exception.

ContractParameters - Interface in com.arc_e_tect.gradle.apionly.transcriberj

What a generation worker derives the contract's model from.

ContractParser - Class in com.arc_e_tect.gradle.apionly.transcriberj.model

Builds a ContractModel from a bundled OpenAPI 3 contract.

ContractRequest - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

A request, as the generated ContractRequest of the same name holds it: the path template and the values that fill it kept apart, and no value encoded.

ContractRequest(String, String, List<String>, List<ContractRequest.Pair>, List<ContractRequest.Pair>, String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

A request as given, with the lists copied so that they cannot change.

ContractRequest.Pair - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

One query parameter or header.

ContractSourcesTask - Class in com.arc_e_tect.gradle.apionly.transcriberj

What every generation task of a contract derives its output from: the fetched documents, the lockfile and the subscription's settings.

ContractSourcesTask() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

Creates the task, with the invalid-request settings at their defaults.

D

declaredHeaders() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the declaredHeaders record component.

declaredQuery() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the declaredQuery record component.

DEFAULT_DESCRIPTION_PLACEHOLDER - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The description of a class or field the contract does not describe, when descriptions are generated.

DEFAULT_INVALID_REQUEST_STATUS - Static variable in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

The status that means "the request is invalid" when a project does not say otherwise.

degraded() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Every degraded method.

degraded(String, String, Finding) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

Records that a generated method cannot represent a construct, and returns the statement its body consists of instead: one that throws UnsupportedOperationException with the reason and, where there is one, the remedy.

Degraded(String, String, String, Finding) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Creates an instance of a Degraded record class.

DEGRADED - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Treatment

The class and its constants are generated; the emitter methods that cannot represent the construct throw UnsupportedOperationException instead.

DELETE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

delete.

dependencies() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.Emitter

The libraries the generated code needs, which the plugin adds to the source sets it generates into when the project does not declare them itself.

derive() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the derive record component.

derive(Settings) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

Derives the contract's model, class names and cases.

derive(Path, Path, String, String, Settings) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.core.Generation

Derives everything the core generates from a contract -- the model, the class names, the invalid-request cases, the report -- and the core's own sources, held in memory.

derives(CaseKind) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Whether a kind of contract case is derived.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the description record component.

description() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the description record component.

descriptionBundle() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the descriptionBundle record component.

descriptionPlaceholder() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the descriptionPlaceholder record component.

detail() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Returns the value of the detail record component.

discriminator() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the discriminator record component.

Discriminator - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A discriminator.

Discriminator(String, Map<String, String>, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Creates an instance of a Discriminator record class.

DISCRIMINATOR - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

discriminator.

E

emit(EmitterContext) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.Emitter

Writes this emitter's classes for one contract.

emitter() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Returns the value of the emitter record component.

emitter(String, Action<? super EmitterSpec>) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Configures one emitter for this subscription: its source sets, its options and where its output goes.

Emitter - Interface in com.arc_e_tect.gradle.apionly.transcriberj.spi

A dialect of generated code: REST Docs descriptors, WireMock stubs, and the like.

EmitterContext - Interface in com.arc_e_tect.gradle.apionly.transcriberj.spi

What an emitter is given to write one contract's classes.

emitterOptions() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the emitterOptions record component.

emitterOptions(String) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

The options the project gave one emitter.

EMITTERS_CONFIGURATION - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The configuration emitter libraries are added to.

EmitterSpec - Class in com.arc_e_tect.gradle.apionly.transcriberj

One emitter's configuration for one subscription: the emitter('<id>') block.

EmitterSpec(String) - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

Creates the block for one emitter.

enumValues() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the enumValues record component.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Recommendation

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AdditionalProperties

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Const

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Provenance

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest.Pair

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Indicates whether some other object is "equal to" this one.

equals(Object) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Indicates whether some other object is "equal to" this one.

exclusiveMaximum() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the exclusiveMaximum record component.

exclusiveMinimum() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the exclusiveMinimum record component.

execute() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction

execute() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction

expectedContentTypes() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the expectedContentTypes record component.

expectedStatus() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the expectedStatus record component.

exposed() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the exposed record component.

F

FILES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Output

Files that belong on no classpath -- mapping files, an archive's contents -- written with EmitterContext.writeFile(String, byte[]), and packaged rather than compiled.

FILES_ARTIFACT_ATTRIBUTE - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

Identifies the contract and emitter represented by an "apionly-files" variant.

FILES_USAGE - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The usage an archive of an emitter's files is published with.

filesArtifactIdentity(String, String) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The value of ApiOnlyTranscriberJPlugin.FILES_ARTIFACT_ATTRIBUTE for a file archive.

finding() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Returns the value of the finding record component.

Finding - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

One occurrence of a classified construct.

Finding(String, Construct, Treatment, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Creates an instance of a Finding record class.

findings() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the findings record component.

format() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the format record component.

fragment() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

The report as a fragment one generation task writes, as JSON: what GenerationReport.render(java.lang.String, java.lang.String) shows, and nothing else, so that a task that runs one emitter writes only that emitter's part.

FRAGMENT_BUNDLED_DIFFERENTLY - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

One fragment bundled into the contract's two documents as different bytes, so that the class generated from it can only match one of them.

fragmentPath() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Provenance

Returns the value of the fragmentPath record component.

fromFragment(String) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Reads a fragment GenerationReport.fragment() wrote.

fromKey(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

The method a path-item key names.

full() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Returns the value of the full record component.

G

gaps() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

The operations that constrain their request input but declare no invalid-request status.

generate() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Generates the core.

generate() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Generates the emitter's output.

GENERATE_TASK - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The prefix of each contract's and each emitter's generation task.

GenerateContractSourcesAction - Class in com.arc_e_tect.gradle.apionly.transcriberj

The core's generation: the schema classes, operations, cases and the endpoint index.

GenerateContractSourcesAction() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction

Creates the action.

GenerateContractSourcesAction.Parameters - Interface in com.arc_e_tect.gradle.apionly.transcriberj

What the task hands over.

GenerateContractSourcesTask - Class in com.arc_e_tect.gradle.apionly.transcriberj

Generates the core of one contract's class tree: the schema classes, the operations and the invalid-request cases, and the endpoint index.

GenerateContractSourcesTask() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Creates the task.

GeneratedClass - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

One core class, as the core emitter names it.

GeneratedClass(String, Origin, String, boolean, Provenance, Schema, boolean) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Creates an instance of a GeneratedClass record class.

generateDocs() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the generateDocs record component.

GenerateEmitterSourcesAction - Class in com.arc_e_tect.gradle.apionly.transcriberj

One emitter's generation, in the class loader the emitters were loaded into.

GenerateEmitterSourcesAction() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction

Creates the action.

GenerateEmitterSourcesAction.Parameters - Interface in com.arc_e_tect.gradle.apionly.transcriberj

What the task hands over.

GenerateEmitterSourcesTask - Class in com.arc_e_tect.gradle.apionly.transcriberj

Generates one emitter's output for one contract, over the same model the core generates from: its Java sources, its classpath resources and its files, each in a directory of its own.

GenerateEmitterSourcesTask() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Creates the task.

Generation - Class in com.arc_e_tect.gradle.apionly.transcriberj.core

One generation run: a contract in, a tree of Java sources out.

Generation.Derivation - Class in com.arc_e_tect.gradle.apionly.transcriberj.core

What Generation.derive(java.nio.file.Path, java.nio.file.Path, java.lang.String, java.lang.String, com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings) works out once: the model, the class names, the cases and the core's report, and the core's output, not yet written.

GenerationException - Exception Class in com.arc_e_tect.gradle.apionly.transcriberj.core

A contract no classes can be generated from, with every reason why.

GenerationException(String) - Constructor for exception class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationException

Creates the exception.

GenerationReport - Class in com.arc_e_tect.gradle.apionly.transcriberj.core

What a generation run could not do in full, and what the specification could do about it: the end-of-run report D14 asks for.

GenerationReport() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Creates an empty report.

GenerationReport.Degraded - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.core

A generated method that throws instead of doing its work.

GenerationReport.NoValidValue - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.core

A generated method that throws because no valid value could be generated for it: none exists, this generator cannot find one, or it reaches a construct no rule represents yet.

GenerationReport.Recommendation - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.core

Something the specification could do better, and how.

GenerationReport.UnsupportedParameter - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.core

A parameter no valid value is generated for yet.

GET - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

get.

getAsciiDocFragment() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction.Parameters

Where the core's part of the report goes, as AsciiDoc.

getAsciiDocFragment() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Where the core's part of the report goes, as AsciiDoc.

getAsciiDocFragment() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the emitter's part of the report goes, as AsciiDoc.

getAsciiDocFragment() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the emitter's part of the report goes, as AsciiDoc.

getAsciiDocFragments() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

The AsciiDoc fragments, the core's first, then each emitter's, which the AsciiDoc report includes.

getAsciiDocReport() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

Where the AsciiDoc report goes.

getAsyncContract() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The contract's AsyncAPI document, or nothing when it has none.

getAsyncContract() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The contract's AsyncAPI document, when it has one: empty otherwise.

getBasePackage() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The base package.

getBasePackage() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The package the core classes are generated into.

getBasePackage() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The package the core classes are generated into.

getBasePackage() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

The package the core classes are in.

getBuildFile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

The consumer project's build.gradle.

getCleanupDsl() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

Whether to remove managed comments from the DSL block.

getContract() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The fetched contract document.

getContract() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The fetched contract document.

getContractName() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The contract's name.

getContractName() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The contract's name.

getContractName() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

The contract's name.

getContractName() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

The contract's name.

getContractSha256() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The locked hash.

getContractVersion() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The locked version.

getCoreFragment() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

The core's part of the report, as JSON.

getDerive() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The kinds of contract case derived.

getDerive() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The kinds of contract case derived.

getDerive() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The kinds of contract case derived: success, notFound, notAcceptable, unsupportedMediaType and invalidRequest.

getDescriptionBundle() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The base name of the bundle descriptions resolve through, or absent when the project supplies none.

getDescriptionBundle() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The base name of the bundle descriptions resolve through, or absent when the project supplies none.

getDescriptionBundle() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The base name of a ResourceBundle the generated classes resolve their descriptions through, such as docs.Descriptions.

getDescriptionPlaceholder() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The description placeholder.

getDescriptionPlaceholder() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The description of what the contract does not describe.

getDescriptionPlaceholder() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The description of a class or field the contract does not describe, when TranscriberJSubscription.getGenerateDocs() is on: it says the description is still to come.

getEmitterClasspath() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

The emitter libraries.

getEmitterFragments() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

Each emitter's part of the report, as JSON, in emitter order.

getEmitterId() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

The emitter's id.

getEmitterId() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

The emitter's id.

getEmitterOptions() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Deprecated.

Configure each emitter in its own block, emitter('<id>') { options = [...] }. Supported until 1.0.0, which removes it; every generation warns while it is set.

getEmitters() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Every emitter this subscription configures with emitter(...), by id.

getEmitterStamps() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

What each emitter's output was generated from, as its generation task recorded it.

getEmitterVersion() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

The emitter's version.

getEmitterVersion() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

The emitter's version, as the transcriberjEmitters configuration resolves it, for the provenance of the files it writes.

getEndpointIndex() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction.Parameters

Where the endpoint index goes.

getEndpointIndex() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Where the endpoint index goes.

getEndpointIndex() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The endpoint index the generation writes: the path of every generated operation and inline schema class, keyed ClassName.PATH.

getEndpointIndexFile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Where the generation writes the endpoint index.

getFilesDirectory() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the emitter's files go.

getFilesDirectory() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the emitter's files go.

getGenerateDocs() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

Whether descriptions come from the contract.

getGenerateDocs() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

Whether descriptions come from the contract.

getGenerateDocs() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Whether the generated descriptions come from the contract.

getGenerateDsl() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

Whether to generate a missing outer DSL block.

getInto() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Where the core's sources -- the schema classes, operations and cases -- are generated.

getIntoFiles() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

Where the emitter's files, which belong on no classpath, are generated.

getIntoJava() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

Where the emitter's Java sources are generated.

getIntoResources() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

Where the emitter's classpath resources are generated.

getIntoResources() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Where the core's resources are generated.

getInvalidRequestStatus() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The status that means "the request is invalid".

getInvalidRequestStatus() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The status that means "the request is invalid".

getInvalidRequestStatus() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The response status that means "the request is invalid".

getJavaDirectory() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the emitter's Java sources go.

getJavaDirectory() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the emitter's Java sources go.

getLockfile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The Subscriber's lockfile, which says which version was fetched.

getLockfile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

The Subscriber's lockfile, for the version the report names.

getLockfile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

The Subscriber's lockfile.

getName() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

The emitter's id.

getName() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The contract's name.

getObjects() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Gradle's object factory, which creates each emitter(...) block.

getOptions() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

The emitter's options, passed to it unchanged; what each means is the emitter's README's to say.

getOptions() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

The emitter's options.

getOptions() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

The emitter's options.

getOutputDirectory() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction.Parameters

Where the sources go.

getOutputDirectory() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Where the core's sources go.

getProvenance() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the provenance of the emitter's files goes, when it writes files.

getProvenance() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the provenance of the emitter's files goes: absent for an emitter that writes none.

getRecursionDepth() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The recursion depth.

getRecursionDepth() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

How many times a recursive reference is followed.

getRecursionDepth() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

How many times a recursive reference is followed before the rest of a body is documented as a subsection.

getReportFile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

Where the text report goes.

getReportFile() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Where the generation writes its report: every degraded method, recommendation and undecided construct.

getReportFragment() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction.Parameters

Where the core's part of the report goes, as JSON.

getReportFragment() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Where the core's part of the report goes, as JSON.

getReportFragment() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the emitter's part of the report goes, as JSON.

getReportFragment() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the emitter's part of the report goes, as JSON.

getResourceDirectory() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction.Parameters

Where the core's resources go.

getResourceDirectory() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Where the core's resources go.

getResourceDirectory() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the emitter's resources go.

getResourceDirectory() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the emitter's classpath resources go.

getSchemaClasses() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

How the schema classes reach the subscription's source sets: perSourceSet, where each source set compiles them, or shared, where one source set, transcriberj<Contract>, compiles them once and every listed source set depends on it.

getSourcesDirectory() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

Where the sources were generated.

getSourceSets() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.EmitterSpec

The source sets the emitter's Java sources and classpath resources go to.

getSourceSets() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The source sets the generated classes are compiled with.

getStamp() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

Where the version the output was generated from is recorded.

getStamp() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Where the contract version and hash the output was generated from are recorded, for verifyContractSources<Contract>.

getStrictDependencies() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJExtension

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

getStrictRequests() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

Whether an undeclared additionalProperties forbids unknown members.

getStrictRequests() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

Whether an undeclared additionalProperties forbids unknown members.

getStrictRequests() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Whether a request object that does not declare additionalProperties forbids members it does not declare, so that an unknown-member case is derived for it.

getSubscriptions() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJExtension

Every contract classes are generated for.

getTranscriberJVersion() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction.Parameters

The TranscriberJ's version.

getTranscriberJVersion() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

The TranscriberJ's version, for the provenance of the files the emitter writes.

getValidateFormats() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The formats an invalid-request case is derived for.

getValidateFormats() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ContractSourcesTask

The formats an invalid-request case is derived for.

getValidateFormats() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

The formats, such as email, an invalid-request case is derived for.

getValidValuesReport() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesAction.Parameters

Where the machine-readable report of every generated valid value goes.

getValidValuesReport() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Where the machine-readable report of every generated valid value goes; nothing is written when it is not set.

getWorkerExecutor() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateContractSourcesTask

Gradle's worker executor.

getWorkerExecutor() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesTask

Gradle's worker executor.

group() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Returns the value of the group record component.

H

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Recommendation

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AdditionalProperties

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Const

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Provenance

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest.Pair

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Returns a hash code value for this object.

hashCode() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns a hash code value for this object.

HEAD - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

head.

headers() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the headers record component.

HttpMethod - Enum Class in com.arc_e_tect.gradle.apionly.transcriberj.model

The HTTP methods an OpenAPI path item can hold an operation for.

I

id() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the id record component.

id() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.Emitter

The emitter's identifier: lower case, such as restdocs.

in() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the in record component.

in() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the in record component.

index() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the index record component.

inline(String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.ClassNames

The class for a schema written inline in an operation.

INLINE_REQUEST - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A schema written inline in an operation's request body.

INLINE_RESPONSE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A schema written inline in an operation's response.

INVALID_REQUEST - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

A request with exactly one constraint violated, expecting the configured invalid-request status.

invalidRequestCases() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

How many invalid-request cases were derived.

invalidRequestStatus() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the invalidRequestStatus record component.

items() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the items record component.

J

JAVA - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Output

Java sources, written with EmitterContext.writeJava(java.lang.String, java.lang.String, java.lang.String), compiled in source sets.

K

key() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the key record component.

key() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the key record component.

key() - Method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

The key a path item holds this method's operation under.

key() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the key record component.

keyword() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the keyword record component.

kind() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the kind record component.

L

literal() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the literal record component.

loader() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.GenerateEmitterSourcesAction

The class loader the emitters are loaded from: the one Gradle built for this action from the transcriberjEmitters configuration.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Recommendation

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Returns the value of the location record component.

location() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Returns the value of the location record component.

M

ManagedDependency - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

A library generated code needs.

ManagedDependency(String, String, String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Creates an instance of a ManagedDependency record class.

mapping() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Returns the value of the mapping record component.

maximum() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the maximum record component.

maxItems() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the maxItems record component.

maxLength() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the maxLength record component.

maxProperties() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the maxProperties record component.

MediaType - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

One entry of a content map.

MediaType(String, Schema, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Creates an instance of a MediaType record class.

messageKeys() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the messageKeys record component.

messages() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the messages record component.

messages() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

The messages of every channel, in declaration order.

method() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Returns the value of the method record component.

method() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Returns the value of the method record component.

method() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the method record component.

method() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the method record component.

minimum() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the minimum record component.

minItems() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the minItems record component.

minLength() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the minLength record component.

minProperties() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the minProperties record component.

model() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

The contract.

MULTIPLE_TYPES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

type naming more than one type, such as [string, 'null'].

multipleOf() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the multipleOf record component.

N

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest.Pair

Returns the value of the name record component.

name() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Returns the value of the name record component.

NAME - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJExtension

The name the extension is registered under.

names() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

The core classes, whose names an emitter's companions follow.

NOT_ACCEPTABLE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

A valid request whose Accept no declared response offers, expecting the declared 406.

NOT_FOUND - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

A valid request naming a resource that does not exist, expecting the declared 404.

note(String) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Records something worth saying about this generation that is not a problem.

notes() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

What this generation had to say about itself.

noValidValue() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Every generated method that throws because no valid value could be generated for it.

NoValidValue(String, String, String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Creates an instance of a NoValidValue record class.

O

ofSetting(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

The kind a setting name names.

ONE_OF_INLINE_BRANCHES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

oneOf with at least one anonymous, inline branch.

ONE_OF_REF_BRANCHES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

oneOf whose branches are all references to components.

oneOf() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the oneOf record component.

openapi() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the openapi record component.

operation(String) - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

The operation with the given operationId.

operation(String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.ClassNames

The class for an operation.

Operation - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

One operation: a method on a path.

Operation(String, HttpMethod, String, List<String>, String, String, List<Parameter>, RequestBody, List<Response>, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Creates an instance of a Operation record class.

OPERATION - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

An operation: a method on a path, with its responses.

operationId() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the operationId record component.

operationId() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the operationId record component.

operationId() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the operationId record component.

operations() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Every operation, path by path, in declaration order.

operations() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Returns the value of the operations record component.

OPTIONS - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

options.

origin() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the origin record component.

Origin - Enum Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

What a generated class was generated from.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns the value of the other record component.

other() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns the value of the other record component.

otherComponents() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the otherComponents record component.

Output - Enum Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

What an emitter writes, in the mode its options select: the plugin places each kind where it belongs, and refuses a configuration that would put it anywhere else.

P

PACKAGE_TASK - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The prefix of each archive task.

Pair(String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest.Pair

Creates an instance of a Pair record class.

Parameter - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

An operation or path-item parameter.

Parameter(Reference, String, String, Boolean, String, Schema, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Creates an instance of a Parameter record class.

PARAMETER - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A reusable parameter component.

parameters() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the parameters record component.

parameters() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the parameters record component.

parameters() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Returns the value of the parameters record component.

parameterSchema(String, String, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

The schema a path, query or header parameter of an operation must satisfy, as a self-contained JSON Schema 2020-12 document, made as EmitterContext.requestBodySchema(java.lang.String, java.lang.String) makes a body's.

parse(String, String) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractParser

Parses a contract's text.

parse(Path) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractParser

Parses a contract file, read as UTF-8.

parse(Path, Path) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractParser

Parses a contract's two documents into one model.

PATCH - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

patch.

path() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the path record component.

path() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Returns the value of the path record component.

PathItem - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

One entry of paths.

PathItem(String, List<Parameter>, List<Operation>, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Creates an instance of a PathItem record class.

pathParameters() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the pathParameters record component.

paths() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the paths record component.

pathTemplate() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the pathTemplate record component.

pattern() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the pattern record component.

PATTERN_PROPERTIES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

patternProperties.

patternProperties() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the patternProperties record component.

payload() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the payload record component.

pinnedVersion() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Returns the value of the pinnedVersion record component.

pointer() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the pointer record component.

POST - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

post.

produces(Map<String, String>) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.Emitter

What this emitter writes with the options it is given: the plugin places Java sources in source sets, resources on their classpath, and files in neither, and fails a configuration that does not fit what is declared here -- source sets for an emitter that writes neither Java nor resources, or none for one that writes Java.

properties() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the properties record component.

propertyName() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Returns the value of the propertyName record component.

provenance() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the provenance record component.

provenance() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the provenance record component.

provenance() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Returns the value of the provenance record component.

provenance() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Returns the value of the provenance record component.

provenance() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the provenance record component.

Provenance - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

Where a component came from.

Provenance(String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Provenance

Creates an instance of a Provenance record class.

PUT - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

put.

Q

query() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns the value of the query record component.

R

reason() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Returns the value of the reason record component.

reason() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Returns the value of the reason record component.

reason() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Returns the value of the reason record component.

Recommendation(String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Recommendation

Creates an instance of a Recommendation record class.

recommendations() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Every recommendation.

recursionDepth() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the recursionDepth record component.

RECURSIVE_REF - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

A $ref that closes a cycle of components.

ref() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the ref record component.

reference() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the reference record component.

reference() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns the value of the reference record component.

reference() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns the value of the reference record component.

Reference - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A $ref written where a parameter, request body or response would be.

Reference(String, String, String, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Creates an instance of a Reference record class.

remedy() - Method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

What a specification author can do so the construct is represented in full.

remedy() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

What a specification author can do so the construct is represented in full.

render(String, String) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

The report as text, for a file and a build log.

renderAsciiDoc(String) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

The report's findings as an AsciiDoc fragment, included by the frame GenerationReport.renderAsciiDocFrame(java.lang.String, java.lang.String, java.util.List<java.lang.String>) writes: one section per kind of finding that has any, each finding shown verbatim, so that nothing a contract says is read as AsciiDoc markup.

renderAsciiDocFrame(String, String, List<String>) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

The frame of the AsciiDoc report: the summary of the whole report, and an include:: of each fragment, in the order given.

renderValidValues(String, String) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Every generated valid value, by class and location, as JSON: members sorted by name, no insignificant whitespace, and a final newline, so the same contract gives the same bytes.

report() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.Generation.Derivation

The core's report.

report() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

Merges the fragments and writes the report.

REPORT_TASK - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The prefix of each contract's report task.

ReportContractSourcesTask - Class in com.arc_e_tect.gradle.apionly.transcriberj

Writes the one report of a subscription from the fragments its generation tasks wrote: the text report, as one generation of the core and every emitter would have written it, and an AsciiDoc report, a frame that summarises it and includes each task's AsciiDoc fragment.

ReportContractSourcesTask() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.ReportContractSourcesTask

Creates the task.

REPRESENTED - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Treatment

Generated in full.

represents() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.Emitter

The classified constructs this emitter represents in full.

request() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the request record component.

REQUEST_BODY - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A reusable request body component.

requestBodies() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the requestBodies record component.

requestBody() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the requestBody record component.

RequestBody - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

An operation's request body.

RequestBody(Reference, String, Boolean, List<MediaType>, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Creates an instance of a RequestBody record class.

requestBodySchema(String, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

The schema a request body of an operation must satisfy, as a self-contained JSON Schema 2020-12 document: every $ref bundled into $defs, strict as the core's own notion of validity is when strictRequests is on, and with format asserted only for the formats validateFormats names -- any other is written as the annotation x-format.

required() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the required record component.

required() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns the value of the required record component.

required() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the required record component.

required() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Returns the value of the required record component.

requiresState() - Method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

Whether a case of this kind can only pass when the target is in a particular state, which a fixture must arrange before the request is sent.

requiresState() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the requiresState record component.

RESOURCES - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Output

Classpath resources, written with EmitterContext.writeResource(java.lang.String, java.lang.String).

Response - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

One response of an operation.

Response(String, Reference, String, List<MediaType>, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Creates an instance of a Response record class.

RESPONSE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A reusable response component.

responseBody(String, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

The body of a response an operation declares, in its first content type: the class that response's contract cases name, and the text its generated requiredBody() and fullBody() return, or why the core cannot build one.

ResponseBody - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

The body of a response an operation declares, as an emitter is given it: the generated class its contract cases name, and the valid bodies that class's requiredBody() and fullBody() return.

ResponseBody(String, ResponseBody.Body, ResponseBody.Body) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Creates an instance of a ResponseBody record class.

ResponseBody.Body - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

One valid body: its text, or, when the core cannot build one, where and why -- what the generated method throws instead.

responseBodyClass() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the responseBodyClass record component.

responses() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the responses record component.

responses() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the responses record component.

Reusable<T> - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A reusable component other than a schema: a response, parameter or request body.

Reusable(String, Provenance, T) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Creates an instance of a Reusable record class.

run(Path, String, String, Settings, Path, Path, List<Emitter>, Path) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.core.Generation

Generates one contract's sources, replacing whatever the output directory held.

run(Path, Path, String, String, Settings, Path, Path, List<Emitter>, Path) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.core.Generation

Generates one contract's sources from both of its documents.

runEmitter(Generation.Derivation, Emitter, Path, Path, Path) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.core.Generation

Runs one emitter over a derivation, replacing whatever its three directories held.

S

schema() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AdditionalProperties

Returns the value of the schema record component.

schema() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Returns the value of the schema record component.

schema() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Returns the value of the schema record component.

schema() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns the value of the schema record component.

schema() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the schema record component.

Schema - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.model

A JSON Schema, as a bundled contract writes it.

Schema(Boolean, String, List<String>, boolean, String, String, Const, List<Object>, List<String>, Map<String, Schema>, Map<String, Schema>, Schema, AdditionalProperties, List<Schema>, List<Schema>, List<Schema>, Discriminator, Constraints, Map<String, Object>, Map<String, Object>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Creates an instance of a Schema record class.

SCHEMA - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

A schema component.

setting() - Method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

How a project names this kind in the derive setting, such as notFound.

settings() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

Every kind's setting name, in canonical order: the default of the derive setting.

settings() - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

How the project has asked for the classes to be generated.

settings(Map<String, Map<String, String>>) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

The settings these parameters describe, with the options of the emitters given.

Settings - Record Class in com.arc_e_tect.gradle.apionly.transcriberj.spi

How a project has asked for one contract's classes to be generated.

Settings(String, String, boolean, String, int) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Settings without a description bundle, as every contract was generated before projects could supply one.

Settings(String, String, boolean, String, int, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Settings with the invalid-request defaults: status "400", strict requests, no format validation, and no emitter options.

Settings(String, String, boolean, String, int, String, String, boolean, List<String>, Map<String, Map<String, String>>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Settings that derive every kind of contract case, as every contract was generated before projects could choose.

Settings(String, String, boolean, String, int, String, String, boolean, List<String>, Map<String, Map<String, String>>, List<String>) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Settings as given, with the lists and maps copied so that they cannot change.

sha256() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Provenance

Returns the value of the sha256 record component.

sha256(Object) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.model.CanonicalJson

The lower-case hex SHA-256 of a value's canonical form, encoded as UTF-8.

simpleName() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns the value of the simpleName record component.

status() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns the value of the status record component.

strictRequests() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the strictRequests record component.

subscription(String, Action<? super TranscriberJSubscription>) - Method in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJExtension

Generates classes for a contract the apiOnlySubscriber block subscribes to.

SUCCESS - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

A valid request, expecting an exact 2xx the operation declares.

summary() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the summary record component.

summary() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns the value of the summary record component.

summary() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the summary record component.

summary() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Returns the value of the summary record component.

T

tags() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns the value of the tags record component.

text() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Returns the value of the text record component.

title() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns the value of the title record component.

title() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns the value of the title record component.

title() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the title record component.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Degraded

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.NoValidValue

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.Recommendation

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AdditionalProperties

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncChannel

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncMessage

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.AsyncOperation

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Component

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Const

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Discriminator

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.MediaType

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Operation

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Parameter

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.PathItem

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Provenance

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reference

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.RequestBody

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Response

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest.Pair

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.GeneratedClass

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody.Body

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ResponseBody

Returns a string representation of this record class.

toString() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns a string representation of this record class.

TRACE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

trace.

TranscriberJSubscription - Class in com.arc_e_tect.gradle.apionly.transcriberj

How the classes for one subscribed contract are generated.

TranscriberJSubscription(String) - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.TranscriberJSubscription

Creates the settings for one contract.

treatment() - Method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

How generated code treats this construct.

treatment() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Finding

Returns the value of the treatment record component.

Treatment - Enum Class in com.arc_e_tect.gradle.apionly.transcriberj.model

What code generation does with a classified construct.

types() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the types record component.

typeWrittenAsList() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the typeWrittenAsList record component.

U

undecided() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Every construct no generation rule has been decided for.

UNDECIDED - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Treatment

No generation rule has been decided for it yet.

uniqueItems() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Constraints

Returns the value of the uniqueItems record component.

unmodelled() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Schema

Returns the value of the unmodelled record component.

UNMODELLED_COMPONENT_TYPE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

A component of a type the model does not type -- anything but schemas, responses, parameters and request bodies -- kept as a raw value.

UNMODELLED_KEYWORD - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

A schema keyword the model does not type, kept as a raw value.

UNSUPPORTED_MEDIA_TYPE - Enum constant in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

The valid body sent with a content type the operation does not accept, expecting the declared 415.

UnsupportedParameter(String, String, String, String) - Constructor for record class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport.UnsupportedParameter

Creates an instance of a UnsupportedParameter record class.

unsupportedParameters() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Every parameter no valid value is generated for yet.

untestedFrom() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ManagedDependency

Returns the value of the untestedFrom record component.

UPDATE_DSL_TASK - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The task that adds missing apiOnlyTranscriberJ properties to the build file.

UpdateApiOnlyTranscriberJDslTask - Class in com.arc_e_tect.gradle.apionly.transcriberj

Adds missing apiOnlyTranscriberJ DSL properties to a consumer's build.gradle, using their real plugin defaults.

UpdateApiOnlyTranscriberJDslTask() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

Creates a new task instance.

updateDsl() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.UpdateApiOnlyTranscriberJDslTask

Updates the consumer build file, keeping a byte-for-byte backup before writing.

V

validateFormats() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.Settings

Returns the value of the validateFormats record component.

value() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Const

Returns the value of the value record component.

value() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.Reusable

Returns the value of the value record component.

value() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractRequest.Pair

Returns the value of the value record component.

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Treatment

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Output

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Construct

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.HttpMethod

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.model.Treatment

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.CaseKind

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Origin

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.arc_e_tect.gradle.apionly.transcriberj.spi.Output

Returns an array containing the constants of this enum class, in the order they are declared.

variant() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.spi.ContractCase

Returns the value of the variant record component.

verify() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

Compares the generated manifest with the lockfile.

VERIFY_TASK - Static variable in class com.arc_e_tect.gradle.apionly.transcriberj.ApiOnlyTranscriberJPlugin

The prefix of each contract's verification task.

VerifyContractSourcesTask - Class in com.arc_e_tect.gradle.apionly.transcriberj

Fails when the generated class tree was generated from another contract than the one the lockfile names (D17): "these tests test the current contract", checked.

VerifyContractSourcesTask() - Constructor for class com.arc_e_tect.gradle.apionly.transcriberj.VerifyContractSourcesTask

Creates the task.

version() - Method in record class com.arc_e_tect.gradle.apionly.transcriberj.model.ContractModel

Returns the value of the version record component.

W

warnings() - Method in class com.arc_e_tect.gradle.apionly.transcriberj.core.GenerationReport

Everything about the contract's design worth a second look.

write(Object) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.model.CanonicalJson

A value's canonical form.

write(Path, String) - Static method in interface com.arc_e_tect.gradle.apionly.transcriberj.ContractParameters

Writes a UTF-8 text file, creating its directory.

writeCore(Generation.Derivation, Path, Path, Path) - Static method in class com.arc_e_tect.gradle.apionly.transcriberj.core.Generation

Writes the core's sources and resources, replacing whatever the two directories held, and the endpoint index.

writeFile(String, byte[]) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

Writes one file that belongs on no classpath -- a mapping file, part of an archive -- replacing any file already written at that path in this run.

writeFile(String, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

Writes one text file that belongs on no classpath, UTF-8 encoded, as EmitterContext.writeFile(String, byte[]) does.

writeJava(String, String, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

Writes one Java source file, replacing any file already written for that class in this run.

writeResource(String, String) - Method in interface com.arc_e_tect.gradle.apionly.transcriberj.spi.EmitterContext

Writes one resource file, replacing any file already written at that path in this run -- a properties file a generated or hand-written class reads through getResourceAsStream, for instance.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form