Module org.freedesktop.cairo

Package org.freedesktop.cairo

Enum Class Status

java.lang.Object

java.lang.Enum<Status>

org.freedesktop.cairo.Status

All Implemented Interfaces:

Serializable, Comparable<Status>, Constable

public enum Status
extends Enum<Status>

Status is used to indicate errors that can occur when using Cairo. In some cases it is returned directly by functions. but when using Context, the last error, if any, is stored in the context and can be retrieved with Context.status().

Cairo uses a single status type to represent all kinds of errors. A status value of SUCCESS represents no error and has an integer value of zero. All other status values represent an error.

Cairo's error handling is designed to be easy to use and safe. All major cairo objects retain an error status internally which can be queried anytime by the users using status() calls. In the mean time, it is safe to call all cairo functions normally even if the underlying object is in an error status. This means that no error handling code is required before or after each individual cairo function call.

New entries may be added in future versions. Use toString() to get a human-readable representation of an error message.

Since:

1.0

See Also:

• Context.status()
• Surface.status()
• Pattern.status()
• FontFace.status()
• ScaledFont.status()
• Region.status()

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIP_NOT_REPRESENTABLE	clip region not representable in desired format
DEVICE_ERROR	an operation to the device caused an unspecified error
DEVICE_FINISHED	target device has been finished
DEVICE_TYPE_MISMATCH	the device type is not appropriate for the operation
DWRITE_ERROR	error occurred in the Windows Direct Write API
FILE_NOT_FOUND	file not found
FONT_TYPE_MISMATCH	the font type is not appropriate for the operation
FREETYPE_ERROR	error occurred in libfreetype
INVALID_CLUSTERS	input clusters do not represent the accompanying text and glyph array
INVALID_CONTENT	invalid value for an input cairo_content_t
INVALID_DASH	invalid value for a dash setting
INVALID_DSC_COMMENT	invalid value for a DSC comment
INVALID_FORMAT	invalid value for an input cairo_format_t
INVALID_INDEX	invalid index passed to getter
INVALID_MATRIX	invalid matrix (not invertible)
INVALID_MESH_CONSTRUCTION	a mesh pattern construction operation was used outside of a cairo_mesh_pattern_begin_patch()/cairo_mesh_pattern_end_patch() pair
INVALID_PATH_DATA	input path data not valid
INVALID_POP_GROUP	no saved group to pop, i.e.
INVALID_RESTORE	cairo_restore() called without matching cairo_save()
INVALID_SIZE	invalid value (typically too big) for the size of the input (surface, pattern, etc.)
INVALID_SLANT	invalid value for an input cairo_font_slant_t
INVALID_STATUS	invalid value for an input t
INVALID_STRIDE	invalid value for stride
INVALID_STRING	input string not valid UTF-8
INVALID_VISUAL	invalid value for an input Visual*
INVALID_WEIGHT	invalid value for an input cairo_font_weight_t
JBIG2_GLOBAL_MISSING	CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID has been used on at least one image but no image provided CAIRO_MIME_TYPE_JBIG2_GLOBAL
LAST_STATUS	this is a special value indicating the number of status values defined in this enumeration.
NEGATIVE_COUNT	negative number used where it is not allowed
NO_CURRENT_POINT	no current point defined
NO_MEMORY	out of memory
NULL_POINTER	NULL pointer
PATTERN_TYPE_MISMATCH	the pattern type is not appropriate for the operation
PNG_ERROR	error occurred in libpng while reading from or writing to a PNG file
READ_ERROR	error while reading from input stream
SUCCESS	no error has occurred
SURFACE_FINISHED	target surface has been finished
SURFACE_TYPE_MISMATCH	the surface type is not appropriate for the operation
SVG_FONT_ERROR	error occurred in OpenType-SVG font rendering
TAG_ERROR	invalid tag name, attributes, or nesting
TEMP_FILE_ERROR	error creating or writing to a temporary file
USER_FONT_ERROR	error occurred in a user-font callback function
USER_FONT_IMMUTABLE	the user-font is immutable
USER_FONT_NOT_IMPLEMENTED	user-font method not implemented
WIN32_GDI_ERROR	error occurred in the Windows Graphics Device Interface
WRITE_ERROR	error while writing to output stream

Method Summary

Modifier and Type	Method	Description
static org.gnome.glib.Type	getType()	Get the CairoStatus GType
int	getValue()	Return the value of this enum
static Status	of(int ordinal)	Returns the enum constant for the given ordinal (its position in the enum declaration).
String	toString()	Provides a human-readable description of a Status.
static Status	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Status[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final Status SUCCESS

no error has occurred

Since:

1.0

NO_MEMORY

public static final Status NO_MEMORY

out of memory

Since:

1.0

INVALID_RESTORE

public static final Status INVALID_RESTORE

cairo_restore() called without matching cairo_save()

Since:

1.0

INVALID_POP_GROUP

public static final Status INVALID_POP_GROUP

no saved group to pop, i.e. cairo_pop_group() without matching cairo_push_group()

Since:

1.0

NO_CURRENT_POINT

public static final Status NO_CURRENT_POINT

no current point defined

Since:

1.0

INVALID_MATRIX

public static final Status INVALID_MATRIX

invalid matrix (not invertible)

Since:

1.0

INVALID_STATUS

public static final Status INVALID_STATUS

invalid value for an input t

Since:

1.0

NULL_POINTER

public static final Status NULL_POINTER

NULL pointer

Since:

1.0

INVALID_STRING

public static final Status INVALID_STRING

input string not valid UTF-8

Since:

1.0

INVALID_PATH_DATA

public static final Status INVALID_PATH_DATA

input path data not valid

Since:

1.0

READ_ERROR

public static final Status READ_ERROR

error while reading from input stream

Since:

1.0

WRITE_ERROR

public static final Status WRITE_ERROR

error while writing to output stream

Since:

1.0

SURFACE_FINISHED

public static final Status SURFACE_FINISHED

target surface has been finished

Since:

1.0

SURFACE_TYPE_MISMATCH

public static final Status SURFACE_TYPE_MISMATCH

the surface type is not appropriate for the operation

Since:

1.0

PATTERN_TYPE_MISMATCH

public static final Status PATTERN_TYPE_MISMATCH

the pattern type is not appropriate for the operation

Since:

1.0

INVALID_CONTENT

public static final Status INVALID_CONTENT

invalid value for an input cairo_content_t

Since:

1.0

INVALID_FORMAT

public static final Status INVALID_FORMAT

invalid value for an input cairo_format_t

Since:

1.0

INVALID_VISUAL

public static final Status INVALID_VISUAL

invalid value for an input Visual*

Since:

1.0

FILE_NOT_FOUND

public static final Status FILE_NOT_FOUND

file not found

Since:

1.0

INVALID_DASH

public static final Status INVALID_DASH

invalid value for a dash setting

Since:

1.0

INVALID_DSC_COMMENT

public static final Status INVALID_DSC_COMMENT

invalid value for a DSC comment

Since:

1.2

INVALID_INDEX

public static final Status INVALID_INDEX

invalid index passed to getter

Since:

1.4

CLIP_NOT_REPRESENTABLE

public static final Status CLIP_NOT_REPRESENTABLE

clip region not representable in desired format

Since:

1.4

TEMP_FILE_ERROR

public static final Status TEMP_FILE_ERROR

error creating or writing to a temporary file

Since:

1.6

INVALID_STRIDE

public static final Status INVALID_STRIDE

invalid value for stride

Since:

1.6

FONT_TYPE_MISMATCH

public static final Status FONT_TYPE_MISMATCH

the font type is not appropriate for the operation

Since:

1.8

USER_FONT_IMMUTABLE

public static final Status USER_FONT_IMMUTABLE

the user-font is immutable

Since:

1.8

USER_FONT_ERROR

public static final Status USER_FONT_ERROR

error occurred in a user-font callback function

Since:

1.8

NEGATIVE_COUNT

public static final Status NEGATIVE_COUNT

negative number used where it is not allowed

Since:

1.8

INVALID_CLUSTERS

public static final Status INVALID_CLUSTERS

input clusters do not represent the accompanying text and glyph array

Since:

1.8

INVALID_SLANT

public static final Status INVALID_SLANT

invalid value for an input cairo_font_slant_t

Since:

1.8

INVALID_WEIGHT

public static final Status INVALID_WEIGHT

invalid value for an input cairo_font_weight_t

Since:

1.8

INVALID_SIZE

public static final Status INVALID_SIZE

invalid value (typically too big) for the size of the input (surface, pattern, etc.)

Since:

1.10

USER_FONT_NOT_IMPLEMENTED

public static final Status USER_FONT_NOT_IMPLEMENTED

user-font method not implemented

Since:

1.10

DEVICE_TYPE_MISMATCH

public static final Status DEVICE_TYPE_MISMATCH

the device type is not appropriate for the operation

Since:

1.10

DEVICE_ERROR

public static final Status DEVICE_ERROR

an operation to the device caused an unspecified error

Since:

1.10

INVALID_MESH_CONSTRUCTION

public static final Status INVALID_MESH_CONSTRUCTION

a mesh pattern construction operation was used outside of a cairo_mesh_pattern_begin_patch()/cairo_mesh_pattern_end_patch() pair

Since:

1.12

DEVICE_FINISHED

public static final Status DEVICE_FINISHED

target device has been finished

Since:

1.12

JBIG2_GLOBAL_MISSING

public static final Status JBIG2_GLOBAL_MISSING

CAIRO_MIME_TYPE_JBIG2_GLOBAL_ID has been used on at least one image but no image provided CAIRO_MIME_TYPE_JBIG2_GLOBAL

Since:

1.14

PNG_ERROR

public static final Status PNG_ERROR

error occurred in libpng while reading from or writing to a PNG file

Since:

1.16

FREETYPE_ERROR

public static final Status FREETYPE_ERROR

error occurred in libfreetype

Since:

1.16

WIN32_GDI_ERROR

public static final Status WIN32_GDI_ERROR

error occurred in the Windows Graphics Device Interface

Since:

1.16

TAG_ERROR

public static final Status TAG_ERROR

invalid tag name, attributes, or nesting

Since:

1.16

DWRITE_ERROR

public static final Status DWRITE_ERROR

error occurred in the Windows Direct Write API

Since:

1.18

SVG_FONT_ERROR

public static final Status SVG_FONT_ERROR

error occurred in OpenType-SVG font rendering

Since:

1.18

LAST_STATUS

public static final Status LAST_STATUS

this is a special value indicating the number of status values defined in this enumeration. When using this value, note that the version of cairo at run-time may have additional status values defined than the value of this symbol at compile-time.

Since:

1.10

Method Details

values

public static Status[] 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 Status 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

getValue

public int getValue()

Return the value of this enum

Returns:

the value

toString

public String toString()

Provides a human-readable description of a Status.

Overrides:

toString in class Enum<Status>

Returns:

a string representation of the status

Since:

1.0

of

public static Status of(int ordinal)

Returns the enum constant for the given ordinal (its position in the enum declaration).

Parameters:

ordinal - the position in the enum declaration, starting from zero

Returns:

the enum constant for the given ordinal

getType

public static org.gnome.glib.Type getType()

Get the CairoStatus GType

Returns:

the GType