org.xwiki.gwt.wysiwyg.client.wiki
Class AttachmentReference

java.lang.Object
  org.xwiki.gwt.wysiwyg.client.wiki.AttachmentReference

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable

public class AttachmentReference
extends Object
implements com.google.gwt.user.client.rpc.IsSerializable

An attachment reference.

Version:

$Id$

Field Summary

static String

FILE_NAME The component that stores the name of the file that hosts the referenced entity.

Constructor Summary

AttachmentReference()
Default constructor.

AttachmentReference(EntityReference entityReference)
Creates a typed attachment reference.

AttachmentReference(String fileName, WikiPageReference wikiPageReference)
Creates a new typed reference to the specified attachment.

Method Summary

AttachmentReference	clone()
boolean	equals(Object obj)
EntityReference	getEntityReference()
String	getFileName()
WikiPageReference	getWikiPageReference()
int	hashCode()
void	setFileName(String fileName) Sets the name of the file that hosts the referenced entity.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_NAME

public static final String FILE_NAME

The component that stores the name of the file that hosts the referenced entity.

See Also:

Constant Field Values

Constructor Detail

AttachmentReference

public AttachmentReference()

Default constructor.

AttachmentReference

public AttachmentReference(EntityReference entityReference)

Creates a typed attachment reference.

Parameters:

entityReference - an entity reference

AttachmentReference

public AttachmentReference(String fileName,
                           WikiPageReference wikiPageReference)

Creates a new typed reference to the specified attachment.

Parameters:

fileName - the file name

wikiPageReference - a reference to the wiki page that holds the attachment

Method Detail

getFileName

public String getFileName()

Returns:

the name of the file that hosts the referenced entity

setFileName

public void setFileName(String fileName)

Sets the name of the file that hosts the referenced entity.

Parameters:

fileName - the name of the file that hosts the referenced entity

getWikiPageReference

public WikiPageReference getWikiPageReference()

Returns:

a reference to the wiki page that holds the referenced attachment

getEntityReference

public EntityReference getEntityReference()

Returns:

the underlying, untyped, entity reference

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

clone

public AttachmentReference clone()

Overrides:

clone in class Object

See Also:

Object.clone()