Package com.helger.photon.api

Class APIRegistry

java.lang.Object

com.helger.photon.api.APIRegistry

All Implemented Interfaces:

IAPIRegistry, Serializable

@ThreadSafe
public class APIRegistry
extends Object
implements IAPIRegistry

Default implementation if IAPIRegistry.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
APIRegistry()

Method Summary

Modifier and Type	Method	Description
com.helger.commons.collection.impl.ICommonsList<IAPIDescriptor>	getAllAPIDescriptors()
InvokableAPIDescriptor	getAPIByPath(APIPath aPath, IAPIPathAmbiguityResolver aAmbiguityResolver)	Find an InvokableAPIDescriptor that matches the provided path.
void	registerAPI(APIDescriptor aDescriptor)	Register a new API descriptor.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.api.IAPIRegistry

getAPIByPath

Constructor Detail

APIRegistry

public APIRegistry()

Method Detail

registerAPI

public void registerAPI(@Nonnull
                        APIDescriptor aDescriptor)

Description copied from interface: IAPIRegistry

Register a new API descriptor. It is the callers responsibility to ensure each API is only registered once.

Specified by:

registerAPI in interface IAPIRegistry

Parameters:

aDescriptor - The descriptor to be registered. May not be null.

getAllAPIDescriptors

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IAPIDescriptor> getAllAPIDescriptors()

Specified by:

getAllAPIDescriptors in interface IAPIRegistry

Returns:

A mutable list of all registered descriptors. Never null but maybe empty.

getAPIByPath

@Nullable
public InvokableAPIDescriptor getAPIByPath(@Nonnull
                                           APIPath aPath,
                                           @Nonnull
                                           IAPIPathAmbiguityResolver aAmbiguityResolver)

Description copied from interface: IAPIRegistry

Find an InvokableAPIDescriptor that matches the provided path.

Specified by:

getAPIByPath in interface IAPIRegistry

Parameters:

aPath - The path to search. May not be null.

aAmbiguityResolver - The ambiguity resolver to be used. May not be null.

Returns:

null if no matching invoker is registered meaning the path cannot be handled by this invoker.

toString

public String toString()

Overrides:

toString in class Object