Package net.officefloor.web.rest.build

Class RestPathContextImpl

java.lang.Object

net.officefloor.web.rest.build.RestPathContextImpl

All Implemented Interfaces:

RestPathContext

public class RestPathContextImpl
extends Object
implements RestPathContext

RestPathContext implementation.

Constructor Summary

Constructors

Constructor	Description
RestPathContextImpl(String path, RestPathContext parentPath)

Method Summary

Modifier and Type	Method	Description
void	addConfiguration(RestConfiguration configuration)
void	addRestMethod(RestMethodContextImpl<?> method)
RestEndpoint	buildRestEndpoint(WebArchitect webArchitect, OfficeArchitect officeArchitect, OfficeSourceContext sourceContext)
void	decorateRestMethods(List<RestMethodDecorator<?>> decorators)
<T> T	getConfiguration(String itemName, Class<T> type)	Obtains additional configuration for the REST path.
RestPathContext	getParentPath()	Obtains the parent RestPathContext.
String	getPath()	Obtains the path.
RestPathContextImpl	getRestPathContext(String path)
boolean	hasRestMethods()
void	loadRestEndpoints(Map<String,RestEndpoint> endpoints, WebArchitect webArchitect, OfficeArchitect officeArchitect, OfficeSourceContext sourceContext)
protected void	visitEndpoints(RestPathContextImpl path, Consumer<RestPathContextImpl> visitor)

Methods inherited from class java.lang.Object

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

Constructor Details

RestPathContextImpl

public RestPathContextImpl(String path,
 RestPathContext parentPath)

Parameters:

path - Path.

parentPath - Parent RestPathContext.

Method Details

getRestPathContext

public RestPathContextImpl getRestPathContext(String path)

Parameters:

path - Path.

Returns:

RestPathContextImpl for the path.

addConfiguration

public void addConfiguration(RestConfiguration configuration)

Parameters:

configuration - RestConfiguration.

addRestMethod

public void addRestMethod(RestMethodContextImpl<?> method)

Parameters:

method - RestMethodContextImpl.

hasRestMethods

public boolean hasRestMethods()

Returns:

Whether there are REST methods.

decorateRestMethods

public void decorateRestMethods(List<RestMethodDecorator<?>> decorators)

Parameters:

decorators - RestMethodDecorator instances.

loadRestEndpoints

public void loadRestEndpoints(Map<String,RestEndpoint> endpoints,
 WebArchitect webArchitect,
 OfficeArchitect officeArchitect,
 OfficeSourceContext sourceContext)

Parameters:

endpoints - Endpoints map to populate.

webArchitect - WebArchitect.

officeArchitect - OfficeArchitect.

sourceContext - OfficeSourceContext.

visitEndpoints

protected void visitEndpoints(RestPathContextImpl path,
 Consumer<RestPathContextImpl> visitor)

Parameters:

path - Root RestPathContextImpl.

visitor - Consumer to visit each endpoint.

buildRestEndpoint

public RestEndpoint buildRestEndpoint(WebArchitect webArchitect,
 OfficeArchitect officeArchitect,
 OfficeSourceContext sourceContext)

Parameters:

webArchitect - WebArchitect.

officeArchitect - OfficeArchitect.

sourceContext - OfficeSourceContext.

Returns:

RestEndpoint.

getPath

public String getPath()

Description copied from interface: RestPathContext

Obtains the path.

Specified by:

getPath in interface RestPathContext

Returns:

Path.

getParentPath

public RestPathContext getParentPath()

Description copied from interface: RestPathContext

Obtains the parent RestPathContext.

Specified by:

getParentPath in interface RestPathContext

Returns:

Parent RestPathContext or null if root path.

getConfiguration

public <T> T getConfiguration(String itemName,
 Class<T> type)

Description copied from interface: RestPathContext

Obtains additional configuration for the REST path.

This for example is CORS specific configuration for the REST path.

Specified by:

getConfiguration in interface RestPathContext

Type Parameters:

T - Type of configuration.

Parameters:

itemName - Name of configuration item.

type - Type of configuration.

Returns:

Configuration item.