org.gatein.api.site

Class SiteId

java.lang.Object

org.gatein.api.site.SiteId

All Implemented Interfaces:

Serializable, Formattable

public class SiteId
extends Object
implements Formattable, Serializable

The id of site

Author:

Nick Scavelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SiteId(Group group) Creates a new site id for a group space (site associated with a group)
SiteId(SiteType type, String name) Creates a new site id for a site with the specified type and name
SiteId(String name) Creates a new site id for a site with the specific name
SiteId(User user) Creates a new site id for a users dashboard (site associated with a user)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
void	formatTo(Formatter formatter, int flags, int width, int precision)
static SiteId	fromString(String idAsString)
String	getName() The name of the site.
SiteType	getType() The SiteType for this SiteId
int	hashCode()
PageId	page(String pageName) Creates a new PageId from this SiteId
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteId

public SiteId(String name)

Creates a new site id for a site with the specific name

Parameters:

name -

SiteId

public SiteId(Group group)

Creates a new site id for a group space (site associated with a group)

Parameters:

group - the group

SiteId

public SiteId(User user)

Creates a new site id for a users dashboard (site associated with a user)

Parameters:

user - the user

SiteId

public SiteId(SiteType type,
      String name)

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

Parameters:

type - the type

name - the name

Method Detail

getType

public SiteType getType()

The SiteType for this SiteId

Returns:

the SiteType

getName

public String getName()

The name of the site.

Returns:

the name

page

public PageId page(String pageName)

Creates a new PageId from this SiteId

Parameters:

pageName - the name of the page

Returns:

a new PageId

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 SiteId fromString(String idAsString)