| java.lang.Object
 com.ecyrd.jspwiki.WikiPage
com.ecyrd.jspwiki.attachment.Attachment
All known Subclasses: com.ecyrd.jspwiki.attachment.DynamicAttachment,
| Attachment | | public class Attachment extends WikiPage (Code) | | Describes an attachment. Attachments are actually derivatives of
a WikiPage, since they do actually have a WikiName as well.
author:
Erik Bunn
author:
Janne Jalkanen |
| Method Summary | |
| public String | getFileName()
Returns the file name of the attachment. | | public String | getParentName()
Returns the name of the parent of this Attachment, i.e. | | public boolean | isCacheable()
Returns true, if this attachment can be cached by the user agent. | | public void | setCacheable(boolean value)
Sets this attachment to be cacheable or not. | | public void | setFileName(String name)
Sets the file name of this attachment. | | public String | toString()
Returns a human-readable, only-debugging-suitable description. |
| Attachment | | public Attachment(WikiEngine engine, String parentPage, String fileName)(Code) | | Creates a new attachment. The final name of the attachment will be
a synthesis of the parent page name and the file name.
Parameters:
engine - The WikiEngine which is hosting this attachment.
Parameters:
parentPage - The page which will contain this attachment.
Parameters:
fileName - The file name for the attachment. |
| getFileName | | public String getFileName()(Code) | | Returns the file name of the attachment.
A String with the file name. |
| getParentName | | public String getParentName()(Code) | | Returns the name of the parent of this Attachment, i.e. the page
which contains this attachment.
String depicting the parent of the attachment. |
| isCacheable | | public boolean isCacheable()(Code) | | Returns true, if this attachment can be cached by the user agent. By default
attachments are cacheable.
False, if the attachment should not be cached by the user agent.
since:
2.5.34 |
| setCacheable | | public void setCacheable(boolean value)(Code) | | Sets this attachment to be cacheable or not. This mostly concerns things
like DynamicAttachments, but it may be useful for certain AttachmentProviders
as well.
Parameters:
value - True or false, depending on whether you want this attachmentto be cacheable or not.
since:
2.5.34 |
| setFileName | | public void setFileName(String name)(Code) | | Sets the file name of this attachment.
Parameters:
name - The name of the attachment. Must be a legal file name withoutthe path. |
| toString | | public String toString()(Code) | | Returns a human-readable, only-debugging-suitable description.
A debugging string |
|
|