org.apache.camel.tools.apt.helper

Class JsonSchemaHelper

java.lang.Object

org.apache.camel.tools.apt.helper.JsonSchemaHelper

public final class JsonSchemaHelper
extends Object

A helper class for JSON schema.

Method Summary

Modifier and Type	Method and Description
static String	getPrimitiveType(String name) Gets the JSon schema primitive type.
static String	getType(String type, boolean enumType) Gets the JSon schema type.
static List<Map<String,String>>	parseJsonSchema(String group, String json, boolean parseProperties) Parses the json schema to split it into a list or rows, where each row contains key value pairs with the metadata
static String	sanitizeDescription(String javadoc, boolean summary) Sanitizes the javadoc to removed invalid characters so it can be used as json description
static String	toJson(String name, String displayName, String kind, Boolean required, String type, String defaultValue, String description, Boolean deprecated, String deprecationNote, Boolean secret, String group, String label, boolean enumType, Set<String> enums, boolean oneOfType, Set<String> oneOffTypes, boolean asPredicate, String optionalPrefix, String prefix, boolean multiValue, String configurationClass, String configurationField)

Methods inherited from class java.lang.Object

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

Method Detail

toJson

public static String toJson(String name,
                            String displayName,
                            String kind,
                            Boolean required,
                            String type,
                            String defaultValue,
                            String description,
                            Boolean deprecated,
                            String deprecationNote,
                            Boolean secret,
                            String group,
                            String label,
                            boolean enumType,
                            Set<String> enums,
                            boolean oneOfType,
                            Set<String> oneOffTypes,
                            boolean asPredicate,
                            String optionalPrefix,
                            String prefix,
                            boolean multiValue,
                            String configurationClass,
                            String configurationField)

getType

public static String getType(String type,
                             boolean enumType)

Gets the JSon schema type.

Parameters:

type - the java type

Returns:

the json schema type, is never null, but returns object as the generic type

getPrimitiveType

public static String getPrimitiveType(String name)

Gets the JSon schema primitive type.

Parameters:

name - the java type

Returns:

the json schema primitive type, or null if not a primitive

sanitizeDescription

public static String sanitizeDescription(String javadoc,
                                         boolean summary)

Sanitizes the javadoc to removed invalid characters so it can be used as json description

Parameters:

javadoc - the javadoc

Returns:

the text that is valid as json

parseJsonSchema

public static List<Map<String,String>> parseJsonSchema(String group,
                                                       String json,
                                                       boolean parseProperties)

Parses the json schema to split it into a list or rows, where each row contains key value pairs with the metadata

Parameters:

group - the group to parse from such as component, componentProperties, or properties.

json - the json

Returns:

a list of all the rows, where each row is a set of key value pairs with metadata