kontent.ai.delivery.generators

Class CodeGenerator

java.lang.Object

kontent.ai.delivery.generators.CodeGenerator

public class CodeGenerator
extends java.lang.Object

Generates java source files using the Kontent.ai Type listing endpoint in the Delivery API

Constructor Summary

Constructors

Constructor and Description
CodeGenerator(java.lang.String projectId, java.lang.String packageName, java.io.File outputDir) Constructs the CodeGenerator

Method Summary

Modifier and Type	Method and Description
com.squareup.javapoet.JavaFile	generateSource(kontent.ai.delivery.ContentType type) Returns a specification of the source representing this type in your Kontent.ai account.
java.util.List<com.squareup.javapoet.JavaFile>	generateSources() Returns a list of specifications of the sources representing the types in your Kontent.ai account
java.util.List<com.squareup.javapoet.JavaFile>	generateSources(kontent.ai.delivery.DeliveryClient client) Returns a list of specifications of the sources representing the types in your Kontent.ai account.
java.util.List<com.squareup.javapoet.JavaFile>	generateSources(java.util.List<kontent.ai.delivery.ContentType> types) Returns a list of specifications of the sources representing the types in your Kontent.ai account.
void	writeSource(com.squareup.javapoet.JavaFile source) Writes the provided specification to the outputDir provided in the constructor.
void	writeSources(java.util.List<com.squareup.javapoet.JavaFile> sources) Writes the provided specifications to the outputDir provided in the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeGenerator

public CodeGenerator(java.lang.String projectId,
                     java.lang.String packageName,
                     java.io.File outputDir)

Constructs the CodeGenerator

Parameters:

projectId - the project id from your Kontent.ai account

packageName - the package to place the generated models under

outputDir - the source root to place the generated models

Throws:

java.lang.UnsupportedOperationException - when a there is a problem with the outputDir

Method Detail

generateSources

public java.util.List<com.squareup.javapoet.JavaFile> generateSources()
                                                               throws java.util.concurrent.ExecutionException,
                                                                      java.lang.InterruptedException

Returns a list of specifications of the sources representing the types in your Kontent.ai account

Returns:

A list of specifications

Throws:

java.util.concurrent.ExecutionException - when a problem occurs communicating with the Kontent.ai API

java.lang.InterruptedException - when a problem occurs communicating with the Kontent.ai API

generateSources

public java.util.List<com.squareup.javapoet.JavaFile> generateSources(kontent.ai.delivery.DeliveryClient client)
                                                               throws java.util.concurrent.ExecutionException,
                                                                      java.lang.InterruptedException

Returns a list of specifications of the sources representing the types in your Kontent.ai account. The provided DeliveryClient param is useful for testing, however in most environments, the default generateSources() method should suffice.

Parameters:

client - A DeliveryClient instance to use to generate the sources.

Returns:

A list of specifications

Throws:

java.util.concurrent.ExecutionException - when a problem occurs communicating with the Kontent.ai API

java.lang.InterruptedException - when a problem occurs communicating with the Kontent.ai API

generateSources

public java.util.List<com.squareup.javapoet.JavaFile> generateSources(java.util.List<kontent.ai.delivery.ContentType> types)

Returns a list of specifications of the sources representing the types in your Kontent.ai account. The provided List of ContentType param is useful for testing, however in most environments, the default generateSources() method should generally be the only method invoking this.

Parameters:

types - A List of ContentType to generate the sources from

Returns:

A list of specifications

generateSource

public com.squareup.javapoet.JavaFile generateSource(kontent.ai.delivery.ContentType type)

Returns a specification of the source representing this type in your Kontent.ai account. Invoking this directly may be useful for testing, however in most environments, the default generateSources() method should suffice.

Parameters:

type - A ContentType to generate the source from

Returns:

A specification

writeSources

public void writeSources(java.util.List<com.squareup.javapoet.JavaFile> sources)
                  throws java.io.IOException

Writes the provided specifications to the outputDir provided in the constructor. This is generally called after a call to generateSources(), but is separated in case you need to make modifications to your specifications before writing.

Parameters:

sources - A list of specifications

Throws:

java.io.IOException - when a problem occurs writing the source files, note some source may have been written when this is thrown

writeSource

public void writeSource(com.squareup.javapoet.JavaFile source)
                 throws java.io.IOException

Writes the provided specification to the outputDir provided in the constructor. This is generally called after a call to generateSources(), but is separated in case you need to make modifications to your specification before writing.

Parameters:

source - A specification

Throws:

java.io.IOException - when a problem occurs writing the source files