org.alfasoftware.soapstone

Class DocumentationProviderBuilder

java.lang.Object

org.alfasoftware.soapstone.DocumentationProviderBuilder

public class DocumentationProviderBuilder
extends java.lang.Object

Builder for DocumentationProvider

Author:

Copyright (c) Alfa Financial Software 2019

Constructor Summary

Constructors

Constructor and Description
DocumentationProviderBuilder()

Method Summary

Modifier and Type	Method and Description
DocumentationProvider	build() Build the DocumentationProvider
DocumentationProviderBuilder	withClassDocumentationProvider(java.util.function.Function<java.lang.Class<?>,java.util.Optional<java.lang.String>> forClass) Deprecated. Use withModelDocumentationProvider(Function) to provide documentation for models and members
DocumentationProviderBuilder	withMemberDocumentationProvider(java.util.function.Function<com.fasterxml.jackson.databind.introspect.AnnotatedMember,java.util.Optional<java.lang.String>> forMember) Deprecated. Use withModelDocumentationProvider(Function) to provide documentation for models and members
DocumentationProviderBuilder	withMethodDocumentationProvider(java.util.function.Function<java.lang.reflect.Method,java.util.Optional<java.lang.String>> forMethod) Optional.
DocumentationProviderBuilder	withMethodReturnDocumentationProvider(java.util.function.Function<java.lang.reflect.Method,java.util.Optional<java.lang.String>> forMethodReturn) Optional.
DocumentationProviderBuilder	withModelDocumentationProvider(java.util.function.Function<java.util.Collection<java.lang.annotation.Annotation>,java.util.Optional<java.lang.String>> forModel) Optional.
DocumentationProviderBuilder	withParameterDocumentationProvider(java.util.function.Function<java.lang.reflect.Parameter,java.util.Optional<java.lang.String>> forParameter) Optional.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationProviderBuilder

public DocumentationProviderBuilder()

Method Detail

withParameterDocumentationProvider

public DocumentationProviderBuilder withParameterDocumentationProvider(java.util.function.Function<java.lang.reflect.Parameter,java.util.Optional<java.lang.String>> forParameter)

Optional. Provide an optional documentation string given a parameter.

Parameters:

forParameter - parameter level documentation provider

Returns:

this

withMethodDocumentationProvider

public DocumentationProviderBuilder withMethodDocumentationProvider(java.util.function.Function<java.lang.reflect.Method,java.util.Optional<java.lang.String>> forMethod)

Optional. Provide an optional documentation string given a method.

Parameters:

forMethod - method level documentation provider

Returns:

this

withMethodReturnDocumentationProvider

public DocumentationProviderBuilder withMethodReturnDocumentationProvider(java.util.function.Function<java.lang.reflect.Method,java.util.Optional<java.lang.String>> forMethodReturn)

Optional. Provide an optional documentation string for the return type given a method.

Parameters:

forMethodReturn - method level documentation provider providing documentation for the method return type

Returns:

this

withModelDocumentationProvider

public DocumentationProviderBuilder withModelDocumentationProvider(java.util.function.Function<java.util.Collection<java.lang.annotation.Annotation>,java.util.Optional<java.lang.String>> forModel)

Optional. Provide an optional documentation string for a model or a property thereof.

The provider will be passed first any annotations for the context in which the model appears (i.e. if it is a property of another model). If no description is returned it will then be passed annotations for the model itself (i.e. class level annotations).

Parameters:

forModel - model or property level documentation provider

Returns:

this

build

public DocumentationProvider build()

Build the DocumentationProvider

Returns:

the built provider

withMemberDocumentationProvider

@Deprecated
public DocumentationProviderBuilder withMemberDocumentationProvider(java.util.function.Function<com.fasterxml.jackson.databind.introspect.AnnotatedMember,java.util.Optional<java.lang.String>> forMember)

Deprecated. Use withModelDocumentationProvider(Function) to provide documentation for models and members

withClassDocumentationProvider

@Deprecated
public DocumentationProviderBuilder withClassDocumentationProvider(java.util.function.Function<java.lang.Class<?>,java.util.Optional<java.lang.String>> forClass)

Deprecated. Use withModelDocumentationProvider(Function) to provide documentation for models and members