Package me.datafox.dfxengine.handles.api

Interface Space

All Superinterfaces:

Comparable<Handled>, Handled

All Known Implementing Classes:

SpaceImpl

public interface Space
extends Handled

A namespace for Handles. May contain Groups to further categorise handles.

Method Summary

Modifier and Type	Method	Description
Group	createGroup(String id)
Handle	createHandle(String id)	Creates a new Handle.
HandleSet	getAllHandles()	Returns an unmodifiable HandleSet containing the Handles of this space, including subhandles.
HandleMap<Group>	getGroups()
HandleManager	getHandleManager()
HandleSet	getHandles()
Group	getOrCreateGroup(String id)	Creates a Group with the specified id if it does not already exist and returns the group with that id.
Handle	getOrCreateHandle(String id)	Creates a Handle with the specified id if it does not already exist and returns the handle with that id.

Methods inherited from interface me.datafox.dfxengine.handles.api.Handled

compareTo, getHandle

Method Details

getHandleManager

HandleManager getHandleManager()

Returns:

HandleManager managing this space

getHandles

HandleSet getHandles()

Returns:

unmodifiable HandleSet containing the Handles of this space, excluding subhandles

getAllHandles

HandleSet getAllHandles()

Returns an unmodifiable HandleSet containing the Handles of this space, including subhandles. Please note that unlike getHandles(), the handle set returned by this method does not reflect handles created after calling this method.

Returns:

unmodifiable HandleSet containing the Handles of this space, including subhandles

createHandle

Handle createHandle(String id)

Creates a new Handle. Throws UnsupportedOperationException if this is the space containing handles of spaces (HandleManager.getSpaceSpace(), use HandleManager.createSpace(String) instead).

Parameters:

id - String id for the new Handle

Returns:

created Handle

Throws:

NullPointerException - if the id is null

IllegalArgumentException - if the id is empty, blank, contains non-ASCII or non-printable characters or more than one colon (:), or if a Handle with the given id already exists in this space

UnsupportedOperationException - if this is the space containing Handles of spaces

getOrCreateHandle

Handle getOrCreateHandle(String id)

Creates a Handle with the specified id if it does not already exist and returns the handle with that id. Throws UnsupportedOperationException if this is the space containing handles of spaces (HandleManager.getSpaceSpace()) and a handle with the specified id is not present. Use HandleManager.getOrCreateSpace(String) instead.

Parameters:

id - String id for the Handle

Returns:

created or pre-existing Handle

Throws:

NullPointerException - if the id is null

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

UnsupportedOperationException - if this is the space containing Handles of spaces and a handle with the specified id is not present

getGroups

HandleMap<Group> getGroups()

Returns:

unmodifiable HandleMap containing the Groups of this space

createGroup

Group createGroup(String id)

Parameters:

id - String id for the new Group

Returns:

created Group

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 Group with the given id already exists in this space

getOrCreateGroup

Group getOrCreateGroup(String id)

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

Parameters:

id - String id for the Group

Returns:

created or pre-existing Group

Throws:

NullPointerException - if the id is null

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