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

java.lang.Object
  extended by com.atlassian.confluence.api.model.BaseApiEnum
      extended by com.atlassian.confluence.api.model.content.ContentRepresentation
All Implemented Interfaces:
ApiEnum

@ExperimentalApi
public final class ContentRepresentation
extends BaseApiEnum

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


Field Summary
static ContentRepresentation ANONYMOUS_EXPORT_VIEW
          HTML representation for viewing, but with absolute urls, instead of relative urls in the markup, and macros are rendered as though it is viewed by an anonymous user.
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 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
 
Fields inherited from class com.atlassian.confluence.api.model.BaseApiEnum
value
 
Method Summary
 boolean convertsFromStorage()
           
 boolean convertsToStorage()
           
 String getRepresentation()
           
 String toString()
           
static ContentRepresentation valueOf(String representation)
           
 
Methods inherited from class com.atlassian.confluence.api.model.BaseApiEnum
equals, getValue, hashCode, in, serialise
 
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.


ANONYMOUS_EXPORT_VIEW

public static final ContentRepresentation ANONYMOUS_EXPORT_VIEW
HTML representation for viewing, but with absolute urls, instead of relative urls in the markup, and macros are rendered as though it is viewed by an anonymous user. Useful for exporting in situations where you might not want to reveal sensitive data , or you do not want to pay the cost of a permission check for the export. The output of this can be cached as long as the underlying content has not changed.


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 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(String representation)

convertsFromStorage

public boolean convertsFromStorage()

convertsToStorage

public boolean convertsToStorage()

getRepresentation

public String getRepresentation()

toString

public String toString()
Overrides:
toString in class BaseApiEnum


Copyright © 2003–2015 Atlassian. All rights reserved.