at.jku.fim.rubanetra.config.model.impl

Class ProtocolClassRegistry

java.lang.Object

at.jku.fim.rubanetra.config.model.impl.ProtocolClassRegistry

public class ProtocolClassRegistry
extends Object

A representation of a simple protocol identifier (ProtocolId) to an arbitrary BaseProtocol class. It is expected that all registered classes provide a default constructor.

See Also:

KrakenProtocolConfigurationBuilderImpl

Constructor Summary

Constructors

Constructor and Description
ProtocolClassRegistry() create a new instance

Method Summary

Modifier and Type	Method and Description
static ProtocolClassRegistry	createDefaultKrakenProtocolRegistry()
Class<? extends BaseProtocol>	getRegisteredProtocolClass(ProtocolId id) Return the registered class for a given protocol identifier
Collection<Class<? extends BaseProtocol>>	getRegisteredProtocolClassList()
Set<ProtocolId>	getRegisteredProtocolIdSet()
void	registerHandler(ProtocolId protocolId, Class<? extends BaseProtocol> protocolHandlerClazz) Register a protocol identifier to a protocol handler class, which must provide a default constructor
void	unregisterHandler(ProtocolId protocolId) Delete a registry record, does nothing if the protocol id was not registered

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtocolClassRegistry

public ProtocolClassRegistry()

create a new instance

Method Detail

registerHandler

public void registerHandler(ProtocolId protocolId,
                            Class<? extends BaseProtocol> protocolHandlerClazz)

Register a protocol identifier to a protocol handler class, which must provide a default constructor

Parameters:

protocolId - a protocol identifier, which should be advertised by the protocolHandlerClazz as well

protocolHandlerClazz - a class that is able to parse the protocol identified by the protocol id and provides a default constructor

Throws:

IllegalArgumentException - if any argument is null or the protocol id was already registered

unregisterHandler

public void unregisterHandler(ProtocolId protocolId)

Delete a registry record, does nothing if the protocol id was not registered

Parameters:

protocolId - the identifier for the handler to delete from the registry

getRegisteredProtocolClass

public Class<? extends BaseProtocol> getRegisteredProtocolClass(ProtocolId id)

Return the registered class for a given protocol identifier

Parameters:

id - the identifier that was registered to this registry

Returns:

a class that should (unchecked) provide a default constructor and should be able to parse data adhering to the protocol identified by the protocol id

getRegisteredProtocolIdSet

public Set<ProtocolId> getRegisteredProtocolIdSet()

Returns:

all currently registered protocol identifiers

getRegisteredProtocolClassList

public Collection<Class<? extends BaseProtocol>> getRegisteredProtocolClassList()

Returns:

all currently registered protocol handler classes (duplicates may be possible)

createDefaultKrakenProtocolRegistry

public static ProtocolClassRegistry createDefaultKrakenProtocolRegistry()

Returns:

a default registry containing all originally known protocol ids and handlers. It will never contain custom protocol handlers unless they are added explicitly afterwards.