com.atlassian.confluence.api.model.content
Class ContentRepresentation

java.lang.Object
  extended by com.atlassian.confluence.api.model.content.ContentRepresentation

@ExperimentalApi
public class ContentRepresentation
extends java.lang.Object

Enumeration of the different built-in ways that Confluence content bodies can be represented.


Field Summary
static ContentRepresentation EDITOR
          Representation suitable for use in the rich text editor
static ContentRepresentation EXPORT_VIEW
          HTML representation for viewing, but with absolute urls, instead of relative urls in the markup.
static java.lang.Iterable<ContentRepresentation> INPUT_CONVERSION_TO_STORAGE_ORDER
          An ordered enumeration of ContentRepresentations that can be converted to STORAGE format.
static ContentRepresentation PLAIN
          Raw database format as plain text with no XHTML or WIKI markup.
static ContentRepresentation RAW
          Raw "database" format.
static ContentRepresentation STORAGE
          Raw database format, for content that stores data in our XML storage format
static ContentRepresentation VIEW
          HTML representation for viewing in a web page
static ContentRepresentation WIKI
          Legacy WIKI representation
 
Method Summary
 boolean convertsFromStorage()
           
 boolean convertsToStorage()
           
 boolean equals(java.lang.Object otherObj)
           
 java.lang.String getRepresentation()
           
 int hashCode()
           
 java.lang.String toString()
           
static ContentRepresentation valueOf(java.lang.String representation)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

RAW

public static final ContentRepresentation RAW
Raw "database" format.


STORAGE

public static final ContentRepresentation STORAGE
Raw database format, for content that stores data in our XML storage format


EDITOR

public static final ContentRepresentation EDITOR
Representation suitable for use in the rich text editor


VIEW

public static final ContentRepresentation VIEW
HTML representation for viewing in a web page


EXPORT_VIEW

public static final ContentRepresentation EXPORT_VIEW
HTML representation for viewing, but with absolute urls, instead of relative urls in the markup. Useful for exporting.


WIKI

public static final ContentRepresentation WIKI
Legacy WIKI representation


PLAIN

public static final ContentRepresentation PLAIN
Raw database format as plain text with no XHTML or WIKI markup.

Can be converted to VIEW representation by converting newlines to <br> and representing URLs as HTML links.


INPUT_CONVERSION_TO_STORAGE_ORDER

public static final java.lang.Iterable<ContentRepresentation> INPUT_CONVERSION_TO_STORAGE_ORDER
An ordered enumeration of ContentRepresentations that can be converted to STORAGE format. When given the option of converting multiple ContentBodys to a STORAGE representation, the body chosen for conversion will be the first one encountered in this list.

Method Detail

valueOf

public static ContentRepresentation valueOf(java.lang.String representation)

convertsFromStorage

public boolean convertsFromStorage()

convertsToStorage

public boolean convertsToStorage()

getRepresentation

public java.lang.String getRepresentation()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object otherObj)
Overrides:
equals in class java.lang.Object


Copyright © 2003-2014 Atlassian. All Rights Reserved.