com.atlassian.confluence.links
Class OutgoingLink

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.links.AbstractLink
              com.atlassian.confluence.links.OutgoingLink

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class OutgoingLink
extends AbstractLink
implements java.lang.Comparable

Represents a link from a source page to a destination.

The destination can currently be:

• Another page in the same space
• A page in another space
• An external URL

See Also:

Serialized Form

Constructor Summary

OutgoingLink()
Default constructor

OutgoingLink(ContentEntityObject sourceContent, java.lang.String destinationSpaceKey, java.lang.String destinationPageTitle)
Convenience constructor

Method Summary

int	compareTo(java.lang.Object o)
boolean	equals(java.lang.Object o)
java.lang.String	getDestinationPageTitle()
java.lang.String	getDestinationSpaceKey()
java.lang.String	getUrlLink()
int	hashCode()
boolean	isFrom(AbstractPage page) Is the link directed from a page, or from some of its contents (i.e.
boolean	isUrlLink()
void	setDestinationPageTitle(java.lang.String destinationPageTitle)
void	setDestinationSpaceKey(java.lang.String destinationSpaceKey)
java.lang.String	toString()

Methods inherited from class com.atlassian.confluence.links.AbstractLink

getLinkTitle, getSourceContent, setLinkTitle, setSourceContent

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

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

Constructor Detail

OutgoingLink

public OutgoingLink()

Default constructor

OutgoingLink

public OutgoingLink(ContentEntityObject sourceContent,
                    java.lang.String destinationSpaceKey,
                    java.lang.String destinationPageTitle)

Convenience constructor

Parameters:

sourceContent - content object that the link comes from

destinationSpaceKey - space the link points to

destinationPageTitle - page the link points to

Method Detail

getDestinationPageTitle

public java.lang.String getDestinationPageTitle()

setDestinationPageTitle

public void setDestinationPageTitle(java.lang.String destinationPageTitle)

getDestinationSpaceKey

public java.lang.String getDestinationSpaceKey()

setDestinationSpaceKey

public void setDestinationSpaceKey(java.lang.String destinationSpaceKey)

isUrlLink

public boolean isUrlLink()

getUrlLink

public java.lang.String getUrlLink()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractLink

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractLink

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isFrom

public boolean isFrom(AbstractPage page)

Is the link directed from a page, or from some of its contents (i.e. comments)? Used to filter out internal links from a page's links list.