Package org.opencms.report
Enum CmsReportFormatType
- java.lang.Object
-
- java.lang.Enum<CmsReportFormatType>
-
- org.opencms.report.CmsReportFormatType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<CmsReportFormatType>
public enum CmsReportFormatType extends java.lang.Enum<CmsReportFormatType>
Enum representing report entry types.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description fmtDefault
Default format.fmtError
Error format.fmtException
Exception format.fmtHeadline
Headline format.fmtNewline
Newline format.fmtNote
Note format.fmtOk
'OK' format.fmtWarning
Warning format.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CmsReportFormatType
byId(int id)
Gets the format enum by its id.static CmsReportFormatType
byName(java.lang.String name)
Gets the format enum by its format naem.int
getFormatId()
Gets the format id.java.lang.String
getFormatName()
Gets the format name.static CmsReportFormatType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static CmsReportFormatType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
fmtDefault
public static final CmsReportFormatType fmtDefault
Default format.
-
fmtError
public static final CmsReportFormatType fmtError
Error format.
-
fmtException
public static final CmsReportFormatType fmtException
Exception format.
-
fmtHeadline
public static final CmsReportFormatType fmtHeadline
Headline format.
-
fmtNewline
public static final CmsReportFormatType fmtNewline
Newline format.
-
fmtNote
public static final CmsReportFormatType fmtNote
Note format.
-
fmtOk
public static final CmsReportFormatType fmtOk
'OK' format.
-
fmtWarning
public static final CmsReportFormatType fmtWarning
Warning format.
-
-
Method Detail
-
values
public static CmsReportFormatType[] 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 (CmsReportFormatType c : CmsReportFormatType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CmsReportFormatType 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
-
byId
public static CmsReportFormatType byId(int id)
Gets the format enum by its id.- Parameters:
id
- the format id- Returns:
- the format enum
-
byName
public static CmsReportFormatType byName(java.lang.String name)
Gets the format enum by its format naem.- Parameters:
name
- the format name- Returns:
- the format enum value
-
getFormatId
public int getFormatId()
Gets the format id.- Returns:
- the format id
-
getFormatName
public java.lang.String getFormatName()
Gets the format name.- Returns:
- the format name
-
-