Enum DashboardExportType
- java.lang.Object
-
- java.lang.Enum<DashboardExportType>
-
- com.orchestranetworks.addon.dqid.dashboard.DashboardExportType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<DashboardExportType>
public enum DashboardExportType extends java.lang.Enum<DashboardExportType>
Represents the available dashboard export types.- Since:
- 1.6.0
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DASHBOARD_TO_PDF
Specifies that the target format is PDF.DASHBOARD_TO_XML
Specifies that the target format is XML.UNSUPPORTED
Represents an unsupported export type.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getTypeValue()
Returns the internal string representing the export type.boolean
isDashboardToPDF()
Returnstrue
if this isDASHBOARD_TO_PDF
.boolean
isDashboardToXML()
Returnstrue
if this isDASHBOARD_TO_XML
.boolean
isUnsupportedType()
Returnstrue
if this isUNSUPPORTED
.static DashboardExportType
parse(java.lang.String type)
ReturnsUNSUPPORTED
if the type is invalid or not supported.static DashboardExportType
valueOf(java.lang.String name)
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.
-
-
-
Enum Constant Detail
-
DASHBOARD_TO_PDF
public static final DashboardExportType 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
public static final DashboardExportType 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
public static final DashboardExportType UNSUPPORTED
Represents an unsupported export type.
-
-
Method Detail
-
values
public static DashboardExportType[] 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 (DashboardExportType c : DashboardExportType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static DashboardExportType 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 namejava.lang.NullPointerException
- 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
public static DashboardExportType parse(java.lang.String type)
ReturnsUNSUPPORTED
if the type is invalid or not supported.
-
getTypeValue
public java.lang.String getTypeValue()
Returns the internal string representing the export type.
-
-