Enum DashboardExportType
- All Implemented Interfaces:
Serializable
,Comparable<DashboardExportType>
,Constable
Represents the available dashboard export types.
- Since:
- 1.6.0
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSpecifies that the target format is PDF.Specifies that the target format is XML.Represents an unsupported export type. -
Method Summary
Modifier and TypeMethodDescriptionReturns the internal string representing the export type.boolean
Returnstrue
if this isDASHBOARD_TO_PDF
.boolean
Returnstrue
if this isDASHBOARD_TO_XML
.boolean
Returnstrue
if this isUNSUPPORTED
.static DashboardExportType
ReturnsUNSUPPORTED
if the type is invalid or not supported.static DashboardExportType
Returns the enum constant of this type with the specified name.static DashboardExportType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
DASHBOARD_TO_PDF
Specifies that the target format is PDF.If the export succeeds, it is possible to retrieve the XML file used to build the PDF file by
DashboardOperations
. -
DASHBOARD_TO_XML
Specifies that the target format is XML.The dashboard can be exported to the XML format first to implement further changes before being transformed to the PDF format.
-
UNSUPPORTED
Represents an unsupported export type.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
isDashboardToPDF
public boolean isDashboardToPDF()Returnstrue
if this isDASHBOARD_TO_PDF
. -
isDashboardToXML
public boolean isDashboardToXML()Returnstrue
if this isDASHBOARD_TO_XML
. -
isUnsupportedType
public boolean isUnsupportedType()Returnstrue
if this isUNSUPPORTED
. -
parse
ReturnsUNSUPPORTED
if the type is invalid or not supported. -
getTypeValue
Returns the internal string representing the export type.
-