Package eu.cloudnetservice.driver.network.http.annotation.parser

Class DefaultHttpAnnotationParser<T extends HttpComponent<T>>

java.lang.Object

eu.cloudnetservice.driver.network.http.annotation.parser.DefaultHttpAnnotationParser<T>

Type Parameters:

T - the type of http component associated with this parser.

All Implemented Interfaces:

HttpAnnotationParser<T>

public final class DefaultHttpAnnotationParser<T extends HttpComponent<T>>
extends Object
implements HttpAnnotationParser<T>

The default implementation of a http annotation parser.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	DefaultHttpAnnotationParser.FirstRequestQueryParamProcessor	A processor for the @FirstRequestQueryParam annotation.
private static final class	DefaultHttpAnnotationParser.RequestBodyProcessor	A processor for the @RequestBody annotation.
private static final class	DefaultHttpAnnotationParser.RequestHeaderProcessor	A processor for the @RequestHeader annotation.
private static final class	DefaultHttpAnnotationParser.RequestPathParamProcessor	A processor for the @RequestPathParam annotation.
private static final class	DefaultHttpAnnotationParser.RequestPathProcessor	A processor for the @RequestPath annotation.
private static final class	DefaultHttpAnnotationParser.RequestQueryParamProcessor	A processor for the @RequestQueryParam annotation.

Field Summary

Fields

Modifier and Type	Field	Description
private final T	component
static final String	DEFAULTS_TO_NULL_MASK
static final String	PARAM_INVOCATION_HINT_KEY
private final Deque<HttpAnnotationProcessor>	processors

Constructor Summary

Constructors

Constructor	Description
DefaultHttpAnnotationParser(T component)	Constructs a new DefaultHttpAnnotationParser instance.

Method Summary

Modifier and Type	Method	Description
@UnmodifiableView @NonNull Collection<HttpAnnotationProcessor>	annotationProcessors()	Get an unmodifiable view of all annotation processors which were registered to this parser.
private static @Nullable Object	applyDefault(@NonNull String defaultValue, @Nullable String actualValue)	Returns the actual value if present, or the default value of an annotation.
T	httpComponent()	Get the http component which is associated with this parser.
@NonNull HttpAnnotationParser<T>	parseAndRegister(@NonNull Class<?> handlerClass)	Parses all non-static http handlers methods annotated with @HttpRequestHandler in the given class instance.
@NonNull HttpAnnotationParser<T>	parseAndRegister(@NonNull Object handlerInstance)	Parses all non-static http handlers methods annotated with @HttpRequestHandler in the given class instance.
@NonNull HttpAnnotationParser<T>	registerAnnotationProcessor(@NonNull HttpAnnotationProcessor processor)	Registers an annotation processor to this parser.
@NonNull HttpAnnotationParser<T>	registerDefaultProcessors()	Registers all processors for the default provided http handling annotations.
@NonNull HttpAnnotationParser<T>	unregisterAnnotationProcessor(@NonNull HttpAnnotationProcessor processor)	Unregisters an annotation processor from this parser if previously registered.
@NonNull HttpAnnotationParser<T>	unregisterAnnotationProcessors(@NonNull ClassLoader classLoader)	Unregisters all annotation processors from this parser whose classes were loaded by the given class loader.
static <T extends HttpComponent<T>> @NonNull HttpAnnotationParser<T>	withDefaultProcessors(T com)	Constructs a new DefaultHttpAnnotationParser instance and registers all processors for the default provided http handling annotations.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULTS_TO_NULL_MASK

public static final String DEFAULTS_TO_NULL_MASK

See Also:

• Constant Field Values

PARAM_INVOCATION_HINT_KEY

public static final String PARAM_INVOCATION_HINT_KEY

See Also:

• Constant Field Values

component

private final T extends HttpComponent<T> component

processors

private final Deque<HttpAnnotationProcessor> processors

Constructor Details

DefaultHttpAnnotationParser

public DefaultHttpAnnotationParser(@NonNull
 T component)

Constructs a new DefaultHttpAnnotationParser instance.

Parameters:

component - the component instance with which this parser is associated.

Throws:

NullPointerException - if the given component is null.

Method Details

applyDefault

@Nullable
private static @Nullable Object applyDefault(@NonNull
 @NonNull String defaultValue,
 @Nullable
 @Nullable String actualValue)

Returns the actual value if present, or the default value of an annotation. If the default value equals to __NULL__ then null is returned, else the given default value.

Parameters:

defaultValue - the defined default value to unmask.

actualValue - the actual value which is present from the request.

Returns:

the actual value if present or the unmasked version of the default value.

Throws:

NullPointerException - if the given default value is null.

withDefaultProcessors

@NonNull
public static <T extends HttpComponent<T>>
@NonNull HttpAnnotationParser<T> withDefaultProcessors(@NonNull
 T com)

Constructs a new DefaultHttpAnnotationParser instance and registers all processors for the default provided http handling annotations.

Parameters:

com - the component instance with which this parser is associated.

Returns:

the newly created HttpAnnotationParser instance.

Throws:

NullPointerException - if the given component is null.

registerDefaultProcessors

@NonNull
public @NonNull HttpAnnotationParser<T> registerDefaultProcessors()

Registers all processors for the default provided http handling annotations.

Returns:

the same instance as used to call the method, for chaining.

httpComponent

@NonNull
public T httpComponent()

Get the http component which is associated with this parser. All handlers parsed using this parser will get registered into that component.

Specified by:

httpComponent in interface HttpAnnotationParser<T extends HttpComponent<T>>

Returns:

the http component associated with this parser.

annotationProcessors

@NonNull
public @UnmodifiableView @NonNull Collection<HttpAnnotationProcessor> annotationProcessors()

Get an unmodifiable view of all annotation processors which were registered to this parser.

Specified by:

annotationProcessors in interface HttpAnnotationParser<T extends HttpComponent<T>>

Returns:

all annotation processors registered to this parser.

registerAnnotationProcessor

@NonNull
public @NonNull HttpAnnotationParser<T> registerAnnotationProcessor(@NonNull
 @NonNull HttpAnnotationProcessor processor)

Registers an annotation processor to this parser.

Specified by:

registerAnnotationProcessor in interface HttpAnnotationParser<T extends HttpComponent<T>>

Parameters:

processor - the processor to register.

Returns:

the same instance as used to call the method, for chaining.

unregisterAnnotationProcessor

@NonNull
public @NonNull HttpAnnotationParser<T> unregisterAnnotationProcessor(@NonNull
 @NonNull HttpAnnotationProcessor processor)

Unregisters an annotation processor from this parser if previously registered.

Specified by:

unregisterAnnotationProcessor in interface HttpAnnotationParser<T extends HttpComponent<T>>

Parameters:

processor - the processor to unregister.

Returns:

the same instance as used to call the method, for chaining.

unregisterAnnotationProcessors

@NonNull
public @NonNull HttpAnnotationParser<T> unregisterAnnotationProcessors(@NonNull
 @NonNull ClassLoader classLoader)

Unregisters all annotation processors from this parser whose classes were loaded by the given class loader.

Specified by:

unregisterAnnotationProcessors in interface HttpAnnotationParser<T extends HttpComponent<T>>

Parameters:

classLoader - the loader of the processor classes to unregister.

Returns:

the same instance as used to call the method, for chaining.

parseAndRegister

@NonNull
public @NonNull HttpAnnotationParser<T> parseAndRegister(@NonNull
 @NonNull Class<?> handlerClass)

Parses all non-static http handlers methods annotated with @HttpRequestHandler in the given class instance. This method will call all previously registered annotation processors and build context preprocessors from them, then register the final parsed handler to the http component associated with this parser.

Specified by:

parseAndRegister in interface HttpAnnotationParser<T extends HttpComponent<T>>

Parameters:

handlerClass - the class in which the handler methods to register are located.

Returns:

the same instance as used to call the method, for chaining.

parseAndRegister

@NonNull
public @NonNull HttpAnnotationParser<T> parseAndRegister(@NonNull
 @NonNull Object handlerInstance)

Parses all non-static http handlers methods annotated with @HttpRequestHandler in the given class instance. This method will call all previously registered annotation processors and build context preprocessors from them, then register the final parsed handler to the http component associated with this parser.

Specified by:

parseAndRegister in interface HttpAnnotationParser<T extends HttpComponent<T>>

Parameters:

handlerInstance - the instance of the class in which the handler methods to register are located.

Returns:

the same instance as used to call the method, for chaining.