com.atlassian.confluence.content.render.xhtml.macro.annotation
Enum Format

java.lang.Object
  extended by java.lang.Enum<Format>
      extended by com.atlassian.confluence.content.render.xhtml.macro.annotation.Format
All Implemented Interfaces:
Serializable, Comparable<Format>

public enum Format
extends Enum<Format>

Used by the RequiresFormat annotation

Since:
4.0
See Also:
RequiresFormat, AnnotationMacroBodyTranformationCondition

Enum Constant Summary
Storage
          Confluence XHTML storage format.
View
          Confluence rendered view format (HTML)
 
Method Summary
static Format valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Format[] 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

Storage

public static final Format Storage
Confluence XHTML storage format.


View

public static final Format View
Confluence rendered view format (HTML)

Method Detail

values

public static Format[] 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 (Format c : Format.values())
    System.out.println(c);

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

valueOf

public static Format valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2003–2015 Atlassian. All rights reserved.