org.xwiki.gwt.wysiwyg.client.wiki
Class WikiPageReference

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.wiki.WikiPageReference

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class WikiPageReference
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

A reference to a wiki page.

Version:

$Id: 694bd0f6b5dbd41fe714d06b82039ab332ddb8ef $

Field Summary

static String	PAGE_NAME The component that stores the name of the page that hosts the referenced entity.
static String	SPACE_NAME The component that stores the name of the space that hosts the referenced entity.
static String	WIKI_NAME The component that stores the name of the wiki that hosts the referenced entity.

Constructor Summary

WikiPageReference()
Default constructor.

WikiPageReference(EntityReference entityReference)
Creates a typed wiki page reference.

WikiPageReference(String wikiName, String spaceName, String pageName)
Creates a reference to the specified wiki page.

Method Summary

boolean	equals(Object obj)
EntityReference	getEntityReference()
String	getPageName()
String	getSpaceName()
String	getWikiName()
int	hashCode()
void	setPageName(String pageName) Sets the name of the page that hosts the referenced entity.
void	setSpaceName(String spaceName) Sets the name of the space that hosts the referenced entity.
void	setWikiName(String wikiName) Sets the name of the wiki that hosts the referenced entity.

Methods inherited from class java.lang.Object

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

Field Detail

WIKI_NAME

public static final String WIKI_NAME

The component that stores the name of the wiki that hosts the referenced entity.

See Also:

Constant Field Values

SPACE_NAME

public static final String SPACE_NAME

The component that stores the name of the space that hosts the referenced entity.

See Also:

Constant Field Values

PAGE_NAME

public static final String PAGE_NAME

The component that stores the name of the page that hosts the referenced entity.

See Also:

Constant Field Values

Constructor Detail

WikiPageReference

public WikiPageReference()

Default constructor.

WikiPageReference

public WikiPageReference(EntityReference entityReference)

Creates a typed wiki page reference.

Parameters:

entityReference - an entity reference

WikiPageReference

public WikiPageReference(String wikiName,
                         String spaceName,
                         String pageName)

Creates a reference to the specified wiki page.

Parameters:

wikiName - the name of the wiki that hosts the page

spaceName - the name of the space that hosts the page

pageName - the name of the page

Method Detail

getWikiName

public String getWikiName()

Returns:

the name of the wiki that hosts the referenced entity

setWikiName

public void setWikiName(String wikiName)

Sets the name of the wiki that hosts the referenced entity.

Parameters:

wikiName - the name of the wiki that hosts the referenced entity

getSpaceName

public String getSpaceName()

Returns:

the name of the space that hosts the referenced entity

setSpaceName

public void setSpaceName(String spaceName)

Sets the name of the space that hosts the referenced entity.

Parameters:

spaceName - the name of the space that hosts the referenced entity

getPageName

public String getPageName()

Returns:

the name of the page that hosts the referenced entity

setPageName

public void setPageName(String pageName)

Sets the name of the page that hosts the referenced entity.

Parameters:

pageName - the name of the page that hosts the referenced entity

getEntityReference

public EntityReference getEntityReference()

Returns:

the underlying, untyped, entity reference

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)