com.ecyrd.jspwiki.attachment

Class Attachment

java.lang.Object

com.ecyrd.jspwiki.WikiPage

com.ecyrd.jspwiki.attachment.Attachment

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

DynamicAttachment

public class Attachment
extends WikiPage

Describes an attachment. Attachments are actually derivatives of a WikiPage, since they do actually have a WikiName as well.

Author:

Erik Bunn

Field Summary

Fields inherited from class com.ecyrd.jspwiki.WikiPage

ALIAS, CHANGENOTE, DESCRIPTION, REDIRECT

Constructor Summary

Constructors

Constructor and Description
Attachment(WikiEngine engine, java.lang.String parentPage, java.lang.String fileName) Creates a new attachment.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileName() Returns the file name of the attachment.
java.lang.String	getParentName() Returns the name of the parent of this Attachment, i.e.
boolean	isCacheable() Returns true, if this attachment can be cached by the user agent.
void	setCacheable(boolean value) Sets this attachment to be cacheable or not.
void	setFileName(java.lang.String name) Sets the file name of this attachment.
java.lang.String	toString() Returns a human-readable, only-debugging-suitable description.

Methods inherited from class com.ecyrd.jspwiki.WikiPage

clone, compareTo, equals, getAcl, getAttribute, getAttributes, getAuthor, getLastModified, getLayerId, getName, getSize, getTransId, getVersion, getWiki, hashCode, hasMetadata, invalidateMetadata, removeAttribute, setAcl, setAttribute, setAuthor, setHasMetadata, setLastModified, setLayerId, setSize, setTransId, setVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

Attachment

public Attachment(WikiEngine engine,
                  java.lang.String parentPage,
                  java.lang.String fileName)

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.

parentPage - The page which will contain this attachment.

fileName - The file name for the attachment.

Method Detail

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

Returns a human-readable, only-debugging-suitable description.

Overrides:

toString in class WikiPage

Returns:

A debugging string

getFileName

public java.lang.String getFileName()

Returns the file name of the attachment.

Returns:

A String with the file name.

setFileName

public void setFileName(java.lang.String name)

Sets the file name of this attachment.

Parameters:

name - The name of the attachment. Must be a legal file name without the path.

getParentName

public java.lang.String getParentName()

Returns the name of the parent of this Attachment, i.e. the page which contains this attachment.

Returns:

String depicting the parent of the attachment.

isCacheable

public boolean isCacheable()

Returns true, if this attachment can be cached by the user agent. By default attachments are cacheable.

Returns:

False, if the attachment should not be cached by the user agent.

Since:

2.5.34

setCacheable

public void setCacheable(boolean value)

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 attachment to be cacheable or not.

Since:

2.5.34