org.gatein.api.page

Class PageId

java.lang.Object

org.gatein.api.page.PageId

All Implemented Interfaces:

Serializable, Formattable

public class PageId
extends Object
implements Formattable, Serializable

The id of a page

Author:

Nick Scavelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PageId(Group group, String pageName) Creates new page id for a page with the specified group (space) and page name
PageId(SiteId siteId, String pageName) Creates a new page id for a page with the specified site id and page name
PageId(String siteName, String pageName) Creates a new page id with the specified site name and page name
PageId(User user, String pageName) Creates a new page id for a page with the specified user (dashboard) and page name

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
void	formatTo(Formatter formatter, int flags, int width, int precision)
static PageId	fromString(String idAsString)
String	getPageName() Returns the name of the page
SiteId	getSiteId() Returns the id of the site
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageId

public PageId(String siteName,
      String pageName)

Creates a new page id with the specified site name and page name

Parameters:

siteName - the site name

pageName - the page name

PageId

public PageId(Group group,
      String pageName)

Creates new page id for a page with the specified group (space) and page name

Parameters:

group - the group

pageName - the page name

PageId

public PageId(User user,
      String pageName)

Creates a new page id for a page with the specified user (dashboard) and page name

Parameters:

user - the user

pageName - the page name

PageId

public PageId(SiteId siteId,
      String pageName)

Creates a new page id for a page with the specified site id and page name

Parameters:

siteId - the site id

pageName - the page name

Method Detail

getSiteId

public SiteId getSiteId()

Returns the id of the site

Returns:

Id of the site

getPageName

public String getPageName()

Returns the name of the page

Returns:

Name of the page

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

formatTo

public void formatTo(Formatter formatter,
            int flags,
            int width,
            int precision)

Specified by:

formatTo in interface Formattable

fromString

public static PageId fromString(String idAsString)