public class

PersonalInformation

extends ContentEntityObject
implements HasLinkWikiMarkup
java.lang.Object
   ↳ com.atlassian.core.bean.EntityObject
     ↳ com.atlassian.confluence.core.ConfluenceEntityObject
       ↳ com.atlassian.confluence.core.AbstractVersionedEntityObject
         ↳ com.atlassian.confluence.core.AbstractLabelableEntityObject
           ↳ com.atlassian.confluence.core.ContentEntityObject
             ↳ com.atlassian.confluence.user.PersonalInformation

Summary

Constants
String CONTENT_TYPE
[Expand]
Inherited Constants
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
Public Constructors
PersonalInformation()
PersonalInformation(User user, UserAccessor userAccessor)
Public Methods
boolean belongsTo(User user)
Returns true if this object belongs to the specified user.
boolean equals(Object o)
String getAttachmentUrlPath(Attachment attachment)
Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments).
List<BodyContent> getBodyContents()
ContentEntityObject getContentEntityObject()
BodyType getDefaultBodyType()
String getDisplayTitle()
Returns the display title.
String getEmail()
String getFullName()
String getHasPersonalSpace()
String getLinkWikiMarkup()
String getNameForComparison()
Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
String getType()
An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
String getUrlPath()
String getUsername()
int hashCode()
void setEmail(String email)
void setFullName(String fullName)
void setUsername(String username)
String toString()
Override this method so we don't call getFullName() everytime toString is called on the object!
[Expand]
Inherited Methods
From class com.atlassian.confluence.core.ContentEntityObject
From class com.atlassian.confluence.core.AbstractLabelableEntityObject
From class com.atlassian.confluence.core.AbstractVersionedEntityObject
From class com.atlassian.confluence.core.ConfluenceEntityObject
From class com.atlassian.core.bean.EntityObject
From class java.lang.Object
From interface com.atlassian.bonnie.Searchable
From interface com.atlassian.confluence.content.Content
From interface com.atlassian.confluence.core.Addressable
From interface com.atlassian.confluence.core.ContentTypeAware
From interface com.atlassian.confluence.core.HasLinkWikiMarkup
From interface com.atlassian.confluence.core.Versioned
From interface com.atlassian.confluence.labels.EditableLabelable
From interface com.atlassian.confluence.labels.Labelable
From interface java.lang.Comparable

Constants

public static final String CONTENT_TYPE

Constant Value: "userinfo"

Public Constructors

public PersonalInformation ()

public PersonalInformation (User user, UserAccessor userAccessor)

Public Methods

public boolean belongsTo (User user)

Returns true if this object belongs to the specified user.

Parameters
user the user to check
Returns
  • true if the user owns this object, otherwise false

public boolean equals (Object o)

public String getAttachmentUrlPath (Attachment attachment)

Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments). Generally you will want to call getUrlPath() instead of this method: if we ever implement view pages for individual attachments, that's the method that will be changed to point to them. The default implementation just returns the view page for this content.

Parameters
attachment one of this content's attachments
Returns
  • the path relative to the base url to view the attachment in the context of this content.

public List<BodyContent> getBodyContents ()

public ContentEntityObject getContentEntityObject ()

public BodyType getDefaultBodyType ()

public String getDisplayTitle ()

Returns the display title. Some entities don't have titles for identification. For example, personal information objects use the user's fullname. Override this method to provide a custom title.

Returns
  • the display title

public String getEmail ()

public String getFullName ()

public String getHasPersonalSpace ()

public String getLinkWikiMarkup ()

public String getNameForComparison ()

Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.

public String getType ()

An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.

This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.

public String getUrlPath ()

public String getUsername ()

public int hashCode ()

public void setEmail (String email)

public void setFullName (String fullName)

public void setUsername (String username)

public String toString ()

Override this method so we don't call getFullName() everytime toString is called on the object!

Returns
  • a string representation of this personal information object