Package com.atlassian.confluence.user

Class PersonalInformation

java.lang.Object
com.atlassian.core.bean.EntityObject
com.atlassian.confluence.core.AnnotatedEntityObject
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
All Implemented Interfaces:
Searchable, Content, Addressable, ContentTypeAware, HasLinkWikiMarkup, Versioned, RelatableEntity, EditableLabelable, Labelable, Serializable, Cloneable, Comparable<ContentEntityObject>
public class PersonalInformation extends ContentEntityObject implements HasLinkWikiMarkup
See Also:

  • Field Details

  • Constructor Details

    • PersonalInformation

      public PersonalInformation()

    • PersonalInformation

      public PersonalInformation(ConfluenceUser user, String personalInformation)
      Since:
      5.2

  • Method Details

    • toString

      public String toString()
      Override this method so we don't call getFullName() everytime toString is called on the object!
      Overrides:
      toString in class ContentEntityObject
      Returns:
      a string representation of this personal information object

    • getDisplayTitle

      public String getDisplayTitle()
      Description copied from class: ContentEntityObject
      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.
      Specified by:
      getDisplayTitle in interface Addressable
      Overrides:
      getDisplayTitle in class ContentEntityObject
      Returns:
      the display title

    • getUrlPath

      public String getUrlPath()
      Specified by:
      getUrlPath in interface Addressable
      Specified by:
      getUrlPath in class ContentEntityObject

    • getAttachmentUrlPath

      public String getAttachmentUrlPath(Attachment attachment)
      Description copied from class: ContentEntityObject
      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 Attachment.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.

      Overrides:
      getAttachmentUrlPath in class ContentEntityObject
      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.

    • getUsername

      @Deprecated public String getUsername()
      Deprecated.
      Since 5.5. Use getUser()

    • getUser

      public ConfluenceUser getUser()
      Since:
      5.2

    • setUser

      public void setUser(ConfluenceUser user)
      Parameters:
      user - this personal information applies to
      Since:
      5.2

    • getDefaultBodyType

      public BodyType getDefaultBodyType()
      Overrides:
      getDefaultBodyType in class ContentEntityObject

    • getBodyContents

      public List<BodyContent> getBodyContents()
      Overrides:
      getBodyContents in class ContentEntityObject

    • belongsTo

      public boolean belongsTo(com.atlassian.user.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
      Since:
      2.8

    • getFullName

      @Deprecated public String getFullName()
      Deprecated.
      Since 5.5. Use getUser()

    • getEmail

      @Deprecated public String getEmail()
      Deprecated.
      Since 5.5. Use getUser()

    • getType

      public String getType()
      Description copied from class: ContentEntityObject
      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.

      Specified by:
      getType in interface ContentTypeAware
      Specified by:
      getType in class ContentEntityObject
      Returns:
      the content type

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ContentEntityObject

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class ContentEntityObject

    • getNameForComparison

      public String getNameForComparison()
      Description copied from class: ContentEntityObject
      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.
      Specified by:
      getNameForComparison in class ContentEntityObject

    • getHasPersonalSpace

      @Deprecated(forRemoval=true, since="9.3") public String getHasPersonalSpace()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 9.3 use SpaceManager.hasPersonalSpace(ConfluenceUser)

    • getLinkWikiMarkup

      public String getLinkWikiMarkup()
      Specified by:
      getLinkWikiMarkup in interface HasLinkWikiMarkup
      Returns:
      the wiki markup used to link to this content