com.atlassian.confluence.importexport.impl
Enum ExportScope

java.lang.Object
  java.lang.Enum<ExportScope>
      com.atlassian.confluence.importexport.impl.ExportScope

All Implemented Interfaces:

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

public enum ExportScope
extends java.lang.Enum<ExportScope>

Represents the valid scopes for an XML Export.

Nested Class Summary

static class

ExportScope.IllegalExportScopeException Indicates an invalid export scope.

Enum Constant Summary

ALL

PAGE

SPACE

Method Summary

static ExportScope	getScopeFromPropertyValue(java.lang.String string) Return an ExportScope for the given string.
java.lang.String	getString() This is the string that represents the scope in the exportDescriptor.properties file.
static ExportScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExportScope[]	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

PAGE

public static final ExportScope PAGE

SPACE

public static final ExportScope SPACE

ALL

public static final ExportScope ALL

Method Detail

values

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

Returns:

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

valueOf

public static ExportScope 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

getString

public java.lang.String getString()

This is the string that represents the scope in the exportDescriptor.properties file.

getScopeFromPropertyValue

public static ExportScope getScopeFromPropertyValue(java.lang.String string)
                                             throws ExportScope.IllegalExportScopeException

Return an ExportScope for the given string.

Parameters:

string - the string that would be used to represent the scope in the exportDescriptor.properties file.

Returns:

the appropriate ExportScope

Throws:

ExportScope.IllegalExportScopeException - if no matching scope was found for the string.