io.micronaut.web.router

Interface RouteBuilder.UriNamingStrategy

All Known Implementing Classes:

ConfigurableUriNamingStrategy, HyphenatedUriNamingStrategy

Enclosing interface:

RouteBuilder

public static interface RouteBuilder.UriNamingStrategy

A URI naming strategy is used to dictate the default name to use when building a URI for a class.

The default strategy is as follows:

• resolveUri(Class) - Where type is example.BookController value is /book
• resolveUri(Class, PropertyConvention) - Where type is example.BookController value is /book{/id}

Implementers can override to provide other strategies such as pluralization etc.

Method Summary

Modifier and Type	Method and Description
default java.lang.String	normalizeUri(java.lang.String uri) Normalizes a URI.
default java.lang.String	resolveUri(BeanDefinition<?> beanDefinition) Resolve the URI to use for the given type.
default java.lang.String	resolveUri(java.lang.Class<?> type) Resolve the URI to use for the given type.
default java.lang.String	resolveUri(java.lang.Class type, PropertyConvention id) Resolve the URI to use for the given type and route id.
default java.lang.String	resolveUri(java.lang.String property) Resolve the URI to use for the given type.

Method Detail

resolveUri

default java.lang.String resolveUri(java.lang.Class<?> type)

Resolve the URI to use for the given type.

Parameters:

type - The type

Returns:

The URI to use

resolveUri

@NonNull
default java.lang.String resolveUri(BeanDefinition<?> beanDefinition)

Resolve the URI to use for the given type.

Parameters:

beanDefinition - The type

Returns:

The URI to use

resolveUri

@NonNull
default java.lang.String resolveUri(java.lang.String property)

Resolve the URI to use for the given type.

Parameters:

property - The property

Returns:

The URI to use

resolveUri

@NonNull
default java.lang.String resolveUri(java.lang.Class type,
                                             PropertyConvention id)

Resolve the URI to use for the given type and route id.

Parameters:

type - The type

id - the route id

Returns:

The URI to use

normalizeUri

default java.lang.String normalizeUri(@Nullable
                                      java.lang.String uri)

Normalizes a URI. Ensures the string: 1) Does not end with a / 2) Starts with a /

Parameters:

uri - The URI

Returns:

The normalized URI or null