Interface GeneratedMethod

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

GeneratedMethod.BuilderBase.GeneratedMethodImpl

public interface GeneratedMethod
extends Prototype.Api

A method to be generated.

Rules for referenced static custom methods:

• The first parameter must be the Prototype type for custom prototype methods
• The first parameter must be the BuilderBase type for custom builder methods
• Custom factory methods are simply referenced

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GeneratedMethod.Builder	Fluent API builder for GeneratedMethod.
static class	GeneratedMethod.BuilderBase<BUILDER extends GeneratedMethod.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends GeneratedMethod>	Fluent API builder base for GeneratedMethod.

Method Summary

Modifier and Type	Method	Description
static GeneratedMethod.Builder	builder()	Create a new fluent API builder to customize configuration.
static GeneratedMethod.Builder	builder(GeneratedMethod instance)	Create a new fluent API builder from an existing instance.
Consumer<ContentBuilder<?>>	contentBuilder()	Generator for the method content.
Optional<Javadoc>	javadoc()	Javadoc for this method.
TypedElementInfo	method()	Definition of this method, including annotations (such as Override).

Method Details

builder

static GeneratedMethod.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static GeneratedMethod.Builder builder(GeneratedMethod instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

method

TypedElementInfo method()

Definition of this method, including annotations (such as Override).

Returns:

method definition

contentBuilder

Consumer<ContentBuilder<?>> contentBuilder()

Generator for the method content.

Returns:

content builder consumer

javadoc

Optional<Javadoc> javadoc()

Javadoc for this method. We intentionally ignore documentation on method(), as it may be complicated to update it.

If not configured, no javadoc will be generated (useful for methods that override documented interface methods).

Returns:

javadoc for this method if defined