org.fujion.page

Class PageRegistry

java.lang.Object

org.fujion.common.AbstractRegistry<String,Page>

org.fujion.page.PageRegistry

All Implemented Interfaces:

Iterable<Page>

public class PageRegistry
extends AbstractRegistry<String,Page>

A registry of all active pages, indexed by their page id.

Field Summary

Fields inherited from class org.fujion.common.AbstractRegistry

map

Method Summary

Modifier and Type	Method and Description
protected String	getKey(Page item)
static Page	getPage(String pid) Convenience method for looking up a registered page.
static Collection<Page>	getPages() Convenience method for returning all registered pages.
static boolean	hasPage(String pid) Returns true if the page specified by its id is registered.
static void	registerPage(Page page) Convenience method for registering a page.
static void	unregisterPage(Page page) Convenience method for unregistering a page.

Methods inherited from class org.fujion.common.AbstractRegistry

clear, contains, get, getAll, iterator, register, size, unregister, unregisterByKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

registerPage

public static void registerPage(Page page)

Convenience method for registering a page.

Parameters:

page - Page to register.

unregisterPage

public static void unregisterPage(Page page)

Convenience method for unregistering a page.

Parameters:

page - Page to unregister.

getPage

public static Page getPage(String pid)

Convenience method for looking up a registered page.

Parameters:

pid - The page id.

Returns:

The page with the specified id.

Throws:

IllegalArgumentException - Thrown if the page cannot be found.

hasPage

public static boolean hasPage(String pid)

Returns true if the page specified by its id is registered.

Parameters:

pid - The page id.

Returns:

True if the page is registered.

getPages

public static Collection<Page> getPages()

Convenience method for returning all registered pages.

Returns:

A read-only collection of all registered pages.

getKey

protected String getKey(Page item)

Specified by:

getKey in class AbstractRegistry<String,Page>