|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ecyrd.jspwiki.WikiPage
public class WikiPage
Simple wrapper class for the Wiki page attributes. The Wiki page content is moved around in Strings, though.
Field Summary | |
---|---|
static String |
ALIAS
|
static String |
DESCRIPTION
"Summary" is a short summary of the page. |
static String |
REDIRECT
|
static String |
SIZE
|
Constructor Summary | |
---|---|
WikiPage(WikiEngine engine,
String name)
|
Method Summary | |
---|---|
Object |
clone()
Creates a deep clone of a WikiPage. |
int |
compareTo(Object o)
|
Acl |
getAcl()
Returns the Acl for this page. |
Object |
getAttribute(String key)
A WikiPage may have a number of attributes, which might or might not be available. |
Map |
getAttributes()
Returns the full attributes Map, in case external code needs to iterate through the attributes. |
String |
getAuthor()
Returns author name, or null, if no author has been defined. |
Date |
getLastModified()
Returns the date when this page was last modified. |
String |
getName()
|
long |
getSize()
|
int |
getVersion()
Returns the version that this WikiPage instance represents. |
String |
getWiki()
Returns the wiki nanme for this page |
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. |
Object |
removeAttribute(String key)
Removes an attribute from the page, if it exists. |
void |
setAcl(Acl acl)
|
void |
setAttribute(String key,
Object attribute)
Sets an metadata attribute. |
void |
setAuthor(String author)
|
void |
setHasMetadata()
|
void |
setLastModified(Date date)
|
void |
setSize(long size)
|
void |
setVersion(int version)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String DESCRIPTION
public static final String ALIAS
public static final String REDIRECT
public static final String SIZE
Constructor Detail |
---|
public WikiPage(WikiEngine engine, String name)
Method Detail |
---|
public String getName()
public Object getAttribute(String key)
key
- The key using which the attribute is fetched
public void setAttribute(String key, Object attribute)
public Map getAttributes()
public Object removeAttribute(String key)
public Date getLastModified()
public void setLastModified(Date date)
public void setVersion(int version)
public int getVersion()
public long getSize()
public void setSize(long size)
public Acl getAcl()
public void setAcl(Acl acl)
public void setAuthor(String author)
public String getAuthor()
public String getWiki()
public void invalidateMetadata()
public boolean hasMetadata()
true
if the page has valid metadata; that is, it has been parsed.
public void setHasMetadata()
public String toString()
toString
in class Object
public Object clone()
clone
in class Object
public int compareTo(Object o)
compareTo
in interface Comparable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |