Package com.atlassian.confluence.importexport.impl

Enum Class ExportScope

java.lang.Object

java.lang.Enum<ExportScope>

com.atlassian.confluence.importexport.impl.ExportScope

All Implemented Interfaces:

Serializable, Comparable<ExportScope>, Constable

public enum ExportScope
extends Enum<ExportScope>

Represents the valid scopes for an XML Export.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExportScope.IllegalExportScopeException	Indicates an invalid export scope.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL
PAGE
SITE
SPACE

Method Summary

Modifier and Type	Method	Description
static ExportScope	getScopeFromPropertyValue(String string)	Return an ExportScope for the given string.
String	getString()	This is the string that represents the scope in the exportDescriptor.properties file.
static ExportScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ExportScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PAGE

public static final ExportScope PAGE

SPACE

public static final ExportScope SPACE

ALL

public static final ExportScope ALL

SITE

public static final ExportScope SITE

Method Details

values

public static ExportScope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ExportScope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getString

public String getString()

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

getScopeFromPropertyValue

public static ExportScope getScopeFromPropertyValue(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.