com.saasquatch.jsonschemainferrer

Interface TitleDescriptionGenerator

public interface TitleDescriptionGenerator

Interface for generating titles, descriptions, and related things. Implementations are expected to be stateless and thread safe.

Author:

sli

See Also:

TitleDescriptionGenerators

Method Summary

Modifier and Type	Method and Description
default String	generateComment(TitleDescriptionGeneratorInput input) Generate a $comment based on the input.
default String	generateDescription(TitleDescriptionGeneratorInput input) Generate a description based on the input
default String	generateTitle(TitleDescriptionGeneratorInput input) Generate a title based on the input

Method Detail

generateTitle

@Nullable
default String generateTitle(@Nonnull
                                       TitleDescriptionGeneratorInput input)

Generate a title based on the input

Returns:

The generated title, or null if no title is generated

generateDescription

@Nullable
default String generateDescription(@Nonnull
                                             TitleDescriptionGeneratorInput input)

Generate a description based on the input

Returns:

The generated title, or null if no description is generated

generateComment

@Nullable
default String generateComment(@Nonnull
                                         TitleDescriptionGeneratorInput input)

Generate a $comment based on the input. Note that $comment is new in draft-07, and it's the implementations' job to be compliant with the specs.

Returns:

The generated comment, or null if no comment is generated