org.jooby.apitool

Class ApiParser

java.lang.Object

org.jooby.apitool.ApiParser

public class ApiParser
extends Object

Parse and extract route metadata from bytecode and documentation from source code.

Since:

1.2.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
ApiParser(Path dir) Creates a new ApiParser.
ApiParser(Path dir, Predicate<RouteMethod> filter) Creates a new ApiParser.

Method Summary

Modifier and Type	Method and Description
Path	export(Path outputBaseDir, String application) Parse application bytecode, build route methods from it and export all metadata to .json.
ApiParser	modify(Predicate<RouteMethod> matcher, Consumer<RouteMethod> customizer) Modify one or more route method who matches the filter.
List<RouteMethod>	parse(String application) Parse application bytecode and build route methods from it.
List<RouteMethod>	parseFully(Jooby application) Parse application bytecode, build route methods from it and merge output with the given routes.
List<RouteMethod>	parseFully(String application, List<Route.Definition> routes) Parse application bytecode, build route methods from it and merge output with the given routes.
ApiParser	with(ClassLoader loader) Set a class loader to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiParser

public ApiParser(Path dir,
                 Predicate<RouteMethod> filter)

Creates a new ApiParser.

Parameters:

dir - Source code directory. Required for javadoc parser.

filter - Route method filter.

ApiParser

public ApiParser(Path dir)

Creates a new ApiParser.

Parameters:

dir - Source code directory. Required for javadoc parser.

Method Detail

parseFully

public List<RouteMethod> parseFully(Jooby application)
                             throws Exception

Parse application bytecode, build route methods from it and merge output with the given routes.

Parameters:

application - Application to parse.

Returns:

List of route methods.

Throws:

Exception - If something goes wrong.

export

public Path export(Path outputBaseDir,
                   String application)
            throws Exception

Parse application bytecode, build route methods from it and export all metadata to .json.

Parameters:

outputBaseDir - Output base directory. This method appends the java package of the given application.

application - Application to parse.

Returns:

List of route methods.

Throws:

Exception - If something goes wrong.

parse

public List<RouteMethod> parse(String application)
                        throws Exception

Parse application bytecode and build route methods from it.

Parameters:

application - Application to parse.

Returns:

List of route methods.

Throws:

Exception - If something goes wrong.

parseFully

public List<RouteMethod> parseFully(String application,
                                    List<Route.Definition> routes)
                             throws Exception

Parse application bytecode, build route methods from it and merge output with the given routes.

Parameters:

application - Application to parse.

routes - Application routes.

Returns:

List of route methods.

Throws:

Exception - If something goes wrong.

with

public ApiParser with(ClassLoader loader)

Set a class loader to use.

Parameters:

loader - Class loader.

Returns:

This parser.

modify

public ApiParser modify(Predicate<RouteMethod> matcher,
                        Consumer<RouteMethod> customizer)

Modify one or more route method who matches the filter. Work as a API to fix possible missing metadata.

Parameters:

matcher - Route matcher.

customizer - Customizer.

Returns:

This parser.