WikiPage (stSoftware API)

java.lang.Object
- com.ecyrd.jspwiki.WikiPage

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

Attachment
```
public class WikiPage
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable
```
Simple wrapper class for the Wiki page attributes. The Wiki page content is moved around in Strings, though.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALIAS` A special variable name for storing a page alias.
`static java.lang.String`	`CHANGENOTE` A special variable name for storing a changenote.
`static java.lang.String`	`DESCRIPTION` "Summary" is a short summary of the page.
`static java.lang.String`	`REDIRECT` A special variable name for storing a redirect note

Constructor Summary

Constructors
Constructor and Description

WikiPage(WikiEngine engine, java.lang.String name)
Create a new WikiPage using a given engine and name.

Constructors
Constructor and Description
`WikiPage(WikiEngine engine, java.lang.String name)` Create a new WikiPage using a given engine and name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Creates a deep clone of a WikiPage.
`int`	`compareTo(java.lang.Object page)` Compares a page with another using the defined PageNameComparator.
`boolean`	`equals(java.lang.Object obj)`
`Acl`	`getAcl()` Returns the Acl for this page.
`java.lang.Object`	`getAttribute(java.lang.String key)` A WikiPage may have a number of attributes, which might or might not be available.
`java.util.Map`	`getAttributes()` Returns the full attributes Map, in case external code needs to iterate through the attributes.
`java.lang.String`	`getAuthor()` Returns author name, or null, if no author has been defined.
`java.util.Date`	`getLastModified()` Returns the date when this page was last modified.
`int`	`getLayerId()`
`java.lang.String`	`getName()` Returns the name of the page.
`long`	`getSize()` Returns the size of the page.
`long`	`getTransId()`
`int`	`getVersion()` Returns the version that this WikiPage instance represents.
`java.lang.String`	`getWiki()` Returns the wiki nanme for this page
`int`	`hashCode()`
`boolean`	`hasMetadata()` Returns `true` if the page has valid metadata; that is, it has been parsed.
`void`	`invalidateMetadata()` This method will remove all metadata from the page.
`java.lang.Object`	`removeAttribute(java.lang.String key)` Removes an attribute from the page, if it exists.
`void`	`setAcl(Acl acl)` Sets the Acl for this page.
`void`	`setAttribute(java.lang.String key, java.lang.Object attribute)` Sets an metadata attribute.
`void`	`setAuthor(java.lang.String author)` Sets the author of the page.
`void`	`setHasMetadata()` Sets the metadata flag to true.
`void`	`setLastModified(java.util.Date date)` Sets the last modification date.
`void`	`setLayerId(int layerId)`
`void`	`setSize(long size)` Sets the size.
`void`	`setTransId(long transId)`
`void`	`setVersion(int version)` Sets the page version.
`java.lang.String`	`toString()` Returns a debug-suitable version of the page.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DESCRIPTION
```
public static final java.lang.String DESCRIPTION
```
    "Summary" is a short summary of the page. It is a String.
    
    See Also:
    
    Constant Field Values
  - ALIAS
```
public static final java.lang.String ALIAS
```
    A special variable name for storing a page alias.
    
    See Also:
    
    Constant Field Values
  - REDIRECT
```
public static final java.lang.String REDIRECT
```
    A special variable name for storing a redirect note
    
    See Also:
    
    Constant Field Values
  - CHANGENOTE
```
public static final java.lang.String CHANGENOTE
```
    A special variable name for storing a changenote.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WikiPage
```
public WikiPage(WikiEngine engine,
                java.lang.String name)
```
    Create a new WikiPage using a given engine and name.
    
    Parameters:
    
    engine - The WikiEngine that owns this page.
    
    name - The name of the page.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name of the page.
    
    Returns:
    
    The page name.
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String key)
```
    A WikiPage may have a number of attributes, which might or might not be available. Typically attributes are things that do not need to be stored with the wiki page to the page repository, but are generated on-the-fly. A provider is not required to save them, but they can do that if they really want.
    
    Parameters:
    
    key - The key using which the attribute is fetched
    
    Returns:
    
    The attribute. If the attribute has not been set, returns null.
  - setAttribute
```
public void setAttribute(java.lang.String key,
                         java.lang.Object attribute)
```
    Sets an metadata attribute.
    
    Parameters:
    
    key - The key for the attribute used to fetch the attribute later on.
    
    attribute - The attribute value
    
    See Also:
    
    getAttribute(String)
  - getAttributes
```
public java.util.Map getAttributes()
```
    Returns the full attributes Map, in case external code needs to iterate through the attributes.
    
    Returns:
    
    The attribute Map. Please note that this is a direct reference, not a copy.
  - removeAttribute
```
public java.lang.Object removeAttribute(java.lang.String key)
```
    Removes an attribute from the page, if it exists.
    
    Parameters:
    
    key - The key for the attribute
    
    Returns:
    
    If the attribute existed, returns the object.
    
    Since:
    
    2.1.111
  - getLastModified
```
public java.util.Date getLastModified()
```
    Returns the date when this page was last modified.
    
    Returns:
    
    The last modification date
  - setLastModified
```
public void setLastModified(java.util.Date date)
```
    Sets the last modification date. In general, this is only changed by the provider.
    
    Parameters:
    
    date - The date
  - setVersion
```
public void setVersion(int version)
```
    Sets the page version. In general, this is only changed by the provider.
    
    Parameters:
    
    version - The version number
  - getVersion
```
public int getVersion()
```
    Returns the version that this WikiPage instance represents.
    
    Returns:
    
    the version number of this page.
  - getSize
```
public long getSize()
```
    Returns the size of the page.
    
    Returns:
    
    the size of the page.
    
    Since:
    
    2.1.109
  - setSize
```
public void setSize(long size)
```
    Sets the size. Typically called by the provider only.
    
    Parameters:
    
    size - The size of the page.
    
    Since:
    
    2.1.109
  - getAcl
```
public Acl getAcl()
```
    Returns the Acl for this page. May return null, in case there is no Acl defined, or it has not yet been set by setAcl(Acl).
    
    Returns:
    
    The access control list. May return null, if there is no acl.
  - setAcl
```
public void setAcl(Acl acl)
```
    Sets the Acl for this page. Note that method does not persist the Acl itself to back-end storage or in page markup; it merely sets the internal field that stores the Acl. To persist the Acl, callers should invoke AclManager.setPermissions(WikiPage, Acl).
    
    Parameters:
    
    acl - The Acl to set
  - setAuthor
```
public void setAuthor(java.lang.String author)
```
    Sets the author of the page. Typically called only by the provider.
    
    Parameters:
    
    author - The author name.
  - getAuthor
```
public java.lang.String getAuthor()
```
    Returns author name, or null, if no author has been defined.
    
    Returns:
    
    Author name, or possibly null.
  - getWiki
```
public java.lang.String getWiki()
```
    Returns the wiki nanme for this page
    
    Returns:
    
    The name of the wiki.
  - invalidateMetadata
```
public void invalidateMetadata()
```
    This method will remove all metadata from the page.
  - hasMetadata
```
public boolean hasMetadata()
```
    Returns true if the page has valid metadata; that is, it has been parsed. Note that this method is a kludge to support our pre-3.0 metadata system, and as such will go away with the new API.
    
    Returns:
    
    true, if the page has metadata.
  - setHasMetadata
```
public void setHasMetadata()
```
    Sets the metadata flag to true. Never call.
  - toString
```
@CheckReturnValue
 @Nonnull
public java.lang.String toString()
```
    Returns a debug-suitable version of the page.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A debug string.
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Creates a deep clone of a WikiPage. Strings are not cloned, since they're immutable. Attributes are not cloned, only the internal HashMap (so if you modify the contents of a value of an attribute, these will reflect back to everyone).
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    A deep clone of the WikiPage
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - compareTo
```
public int compareTo(java.lang.Object page)
```
    Compares a page with another using the defined PageNameComparator. See com.ecyrd.jspwiki.util.PageSorter.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable
    
    Parameters:
    
    page - The object to compare against
    
    Returns:
    
    -1, 0 or 1
  - hashCode
```
@CheckReturnValue
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getTransId
```
public long getTransId()
```
    Returns:
    
    the transId
  - setTransId
```
public void setTransId(long transId)
```
    Parameters:
    
    transId - the transId to set
  - getLayerId
```
public int getLayerId()
```
    Returns:
    
    the layerId
  - setLayerId
```
public void setLayerId(int layerId)
```
    Parameters:
    
    layerId - the layerId to set

Class WikiPage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DESCRIPTION

ALIAS

REDIRECT

CHANGENOTE

Constructor Detail

WikiPage

Method Detail

getName

getAttribute

setAttribute

getAttributes

removeAttribute

getLastModified

setLastModified

setVersion

getVersion

getSize

setSize

getAcl

setAcl

setAuthor

getAuthor

getWiki

invalidateMetadata

hasMetadata

setHasMetadata

toString

clone

compareTo

hashCode

equals

getTransId

setTransId

getLayerId

setLayerId