Package ddf.catalog.data

Interface AttributeRegistry

public interface AttributeRegistry

Manages registered attribute types.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method	Description
void	deregister(AttributeDescriptor attributeDescriptor)	Removes an attribute from the registry.
Optional<AttributeDescriptor>	lookup(String name)	Gets the AttributeDescriptor for the attribute with the given name.
void	register(AttributeDescriptor attributeDescriptor)	Registers a new attribute.

Method Details

register

void register(AttributeDescriptor attributeDescriptor)

Registers a new attribute.

Parameters:

attributeDescriptor - the AttributeDescriptor describing the attribute

Throws:

IllegalArgumentException - if attributeDescriptor or AttributeDescriptor.getName() is null

deregister

void deregister(AttributeDescriptor attributeDescriptor)

Removes an attribute from the registry.

Does nothing if the attributeDescriptor does not exist in the registry.

Parameters:

attributeDescriptor - an attributeDescriptor for the attribute

Throws:

IllegalArgumentException - if attributeDescriptor is null

lookup

Optional<AttributeDescriptor> lookup(String name)

Gets the AttributeDescriptor for the attribute with the given name.

Returns an empty Optional if no attribute by the name name exists in the registry.

Parameters:

name - the name of the attribute

Returns:

an Optional containing the registered AttributeDescriptor

Throws:

IllegalArgumentException - if name is null