Package me.datafox.dfxengine.handles

Class SpaceImpl

java.lang.Object

me.datafox.dfxengine.handles.SpaceImpl

All Implemented Interfaces:

Comparable<Handled>, Handled, Space

public class SpaceImpl
extends Object
implements Space

Implementation of Space.

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()
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.
String	toString()

Methods inherited from class java.lang.Object

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

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

compareTo, getHandle

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

getHandleManager

Method Details

getHandles

public HandleSet getHandles()

Specified by:

getHandles in interface Space

Returns:

unmodifiable HandleSet containing the Handles of this space, excluding subhandles

getAllHandles

public HandleSet getAllHandles()

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

Specified by:

getAllHandles in interface Space

Returns:

unmodifiable HandleSet containing the Handles of this space, including subhandles

createHandle

public 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).

Specified by:

createHandle in interface Space

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

public 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.

Specified by:

getOrCreateHandle in interface Space

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

public HandleMap<Group> getGroups()

Specified by:

getGroups in interface Space

Returns:

unmodifiable HandleMap containing the Groups of this space

createGroup

public Group createGroup(String id)

Specified by:

createGroup in interface Space

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

public Group getOrCreateGroup(String id)

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

Specified by:

getOrCreateGroup in interface Space

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 (:)

toString

public String toString()

Overrides:

toString in class Object