com.hp.sdn.adm.rsdoc

Interface RSDocRegistry

public interface RSDocRegistry

Registry service for dynamically tracking and aggregating REST API documentation from various contributors.

Author:

Thomas Vachuska

Method Summary

Methods

Modifier and Type	Method and Description
void	add(RSDocProvider provider) Adds a REST API documentation provider to the registry.
RSDocProvider	get(String name) Gets the REST API documentation provider with the specified name.
Set<RSDocProvider>	providers() Gets the set of all registered REST API documentation providers.
void	remove(String name) Removes a REST API documentation provider from the registry.

Method Detail

providers

Set<RSDocProvider> providers()

Gets the set of all registered REST API documentation providers.

Returns:

set of all registered providers

get

RSDocProvider get(String name)

Gets the REST API documentation provider with the specified name.

Parameters:

name - name of the document provider to be removed

Returns:

document provider

Throws:

NotFoundException - if given provider has not been registered

add

void add(RSDocProvider provider)

Adds a REST API documentation provider to the registry.

Parameters:

provider - document provider to be added

remove

void remove(String name)
            throws NotFoundException

Removes a REST API documentation provider from the registry.

Parameters:

name - name of the document provider to be removed

Throws:

NotFoundException - if given provider has not been registered