Package me.datafox.dfxengine.handles.api

Interface HandleManager

All Known Implementing Classes:

HandleManagerImpl

public interface HandleManager

A singleton class that manages Spaces and Handles. Contains two hardcoded spaces, one for the handles used to identify spaces themselves, and one for tag handles.

Method Summary

Modifier and Type	Method	Description
Space	createSpace(String id)
Space	getOrCreateSpace(String id)	Creates a Space with the specified id if it does not already exist and returns the space with that id.
HandleMap<Space>	getSpaces()
Space	getSpaceSpace()
Space	getTagSpace()

Method Details

getSpaceSpace

Space getSpaceSpace()

Returns:

Space containing Handles used for identifying spaces

getTagSpace

Space getTagSpace()

Returns:

Space containing tag Handles

getSpaces

HandleMap<Space> getSpaces()

Returns:

unmodifiable HandleMap containing all Spaces managed by this handle manager

createSpace

Space createSpace(String id)

Parameters:

id - String id for the new Space

Returns:

created Space

Throws:

NullPointerException - if the id is null

IllegalArgumentException - if the id is empty, blank, contains non-ASCII or non-printable characters or the colon (:), or if a Space with the given id already exists

getOrCreateSpace

Space getOrCreateSpace(String id)

Creates a Space with the specified id if it does not already exist and returns the space with that id.

Parameters:

id - String id for the Space

Returns:

created or pre-existing Space

Throws:

NullPointerException - if the id is null

IllegalArgumentException - if the id is empty, blank, contains non-ASCII or non-printable characters or the colon (:)