Package org.xwiki.wiki.descriptor

Class WikiDescriptor

java.lang.Object

org.xwiki.wiki.descriptor.WikiDescriptor

All Implemented Interfaces:

Cloneable

public class WikiDescriptor
extends Object
implements Cloneable

This class is a descriptor for wiki.

Since:

5.3M2

Version:

$Id: fb418766c55d21302e5b7a29cbf98d16f24f3d22 $

Constructor Summary

Constructors

Constructor	Description
WikiDescriptor(String id, String defaultAlias)	Constructor.
WikiDescriptor(String id, String defaultAlias, String ownerId)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addAlias(String alias)
void	addPropertyGroup(WikiPropertyGroup group)	Add a property group to the wiki.
WikiDescriptor	clone()
boolean	equals(Object object)
List<String>	getAliases()
String	getDefaultAlias()	The default alias is the alias used to generate URL for that wiki.
String	getDescription()
String	getId()
DocumentReference	getMainPageReference()
String	getOwnerId()
int	getPort()
String	getPrettyName()
WikiPropertyGroup	getPropertyGroup(String propertyGroupId)
WikiReference	getReference()
int	hashCode()
boolean	isHidden()
Boolean	isSecure()
void	setDefaultAlias(String alias)	Set the default alias.
void	setDescription(String description)
void	setHidden(boolean hidden)	Set if the wiki is hidden.
void	setMainPageReference(DocumentReference reference)
void	setOwnerId(String ownerId)
void	setPort(int port)
void	setPrettyName(String prettyName)
void	setSecure(Boolean secure)

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiDescriptor

public WikiDescriptor(String id,
                      String defaultAlias)

Constructor.

Parameters:

id - Unique Id of the wiki

defaultAlias - Default alias of the wiki

WikiDescriptor

public WikiDescriptor(String id,
                      String defaultAlias,
                      String ownerId)

Constructor.

Parameters:

id - Unique Id of the wiki

defaultAlias - Default alias of the wiki

ownerId - the identifier of the owner of the wiki (generally a serialized user reference)

Since:

11.3, 10.11.8

Method Detail

getId

public String getId()

Returns:

the unique Id of the wiki.

getDefaultAlias

public String getDefaultAlias()

The default alias is the alias used to generate URL for that wiki.

Returns:

the default alias.

setDefaultAlias

public void setDefaultAlias(String alias)

Set the default alias.

Parameters:

alias - the new default alias

addAlias

public void addAlias(String alias)

Parameters:

alias - the new alias to add

getAliases

public List<String> getAliases()

Returns:

all aliases

getPrettyName

public String getPrettyName()

Returns:

the pretty name of the wiki

setPrettyName

public void setPrettyName(String prettyName)

Parameters:

prettyName - the new pretty name

getOwnerId

public String getOwnerId()

Returns:

the Id of the owner of the wiki

setOwnerId

public void setOwnerId(String ownerId)

Parameters:

ownerId - the Id of the owner of the wiki

getReference

public WikiReference getReference()

Returns:

a reference to that wiki

getMainPageReference

public DocumentReference getMainPageReference()

Returns:

a reference to the main page of the wiki

setMainPageReference

public void setMainPageReference(DocumentReference reference)

Parameters:

reference - Reference to the main page of the wiki

isHidden

public boolean isHidden()

Returns:

if the wiki is hidden

setHidden

public void setHidden(boolean hidden)

Set if the wiki is hidden.

Parameters:

hidden - if the wiki is hidden or not

getDescription

public String getDescription()

Returns:

the wiki description

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

isSecure

public Boolean isSecure()

Returns:

true if the wiki should be accessed trough a secure connection (HTTPS), null means default

Since:

10.7RC1

setSecure

public void setSecure(Boolean secure)

Parameters:

secure - true if the wiki should be accessed trough a secure connection (HTTPS), null means default

Since:

10.7RC1

getPort

public int getPort()

Returns:

the port to use when generating external URL for the wiki, -1 means default

Since:

10.7RC1

setPort

public void setPort(int port)

Parameters:

port - the port to use when generating external URL for the wiki, -1 means default

Since:

10.7RC1

getPropertyGroup

public WikiPropertyGroup getPropertyGroup(String propertyGroupId)

Parameters:

propertyGroupId - the id of the property group to retrieve

Returns:

the property group corresponding to the id, or null if no property group correspond to that Id.

addPropertyGroup

public void addPropertyGroup(WikiPropertyGroup group)

Add a property group to the wiki.

Parameters:

group - property group to add

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

clone

public WikiDescriptor clone()

Overrides:

clone in class Object