com.atlassian.confluence.api.model.content

Enum ContentRepresentation

java.lang.Object

java.lang.Enum<ContentRepresentation>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContentRepresentation>

@ExperimentalApi
public enum ContentRepresentation
extends java.lang.Enum<ContentRepresentation>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDITOR Representation suitable for use in the rich text editor
EXPORT_VIEW HTML representation for viewing, but with absolute urls, instead of relative urls in the markup.
RAW Raw "database" format.
STORAGE Raw database format, for content that stores data in our XML storage format
VIEW HTML representation for viewing in a web page
WIKI Legacy WIKI representation

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Iterable<ContentRepresentation>	INPUT_CONVERSION_TO_STORAGE_ORDER An ordered enumeration of ContentRepresentations that can be converted to STORAGE format.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	convertsFromStorage()
boolean	convertsToStorage()
static ContentRepresentation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ContentRepresentation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant 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

Field Detail

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

values

public static ContentRepresentation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ContentRepresentation c : ContentRepresentation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

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

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

convertsFromStorage

public boolean convertsFromStorage()

convertsToStorage

public boolean convertsToStorage()