com.github.mangstadt.vinnie.io

Enum Warning

java.lang.Object

java.lang.Enum<Warning>

com.github.mangstadt.vinnie.io.Warning

All Implemented Interfaces:

Serializable, Comparable<Warning>

public enum Warning
extends Enum<Warning>

Lists the non-fatal problems that can occur when parsing a vobject data stream.

Author:

Michael Angstadt

See Also:

VObjectDataListener.onWarning(com.github.mangstadt.vinnie.io.Warning, com.github.mangstadt.vinnie.VObjectProperty, java.lang.Exception, com.github.mangstadt.vinnie.io.Context)

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMPTY_BEGIN When a BEGIN property value is empty (it is supposed to contain the name of a component).
EMPTY_END When an END property value is empty (it is supposed to contain the name of a component).
MALFORMED_LINE When a line cannot be parsed.
QUOTED_PRINTABLE_ERROR When a property value cannot be decoded from quoted-printable encoding.
UNKNOWN_CHARSET When a property value is encoded in quoted-printable encoding and its defined character set is not recognized by the JVM.
UNKNOWN_VERSION When a VERSION property is not recognized by the parser's SyntaxRules.
UNMATCHED_END When the component in an END property does not match up with any BEGIN properties.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Gets a message describing the warning.
String	toString()
static Warning	valueOf(String name) Returns the enum constant of this type with the specified name.
static Warning[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MALFORMED_LINE

public static final Warning MALFORMED_LINE

When a line cannot be parsed.

EMPTY_BEGIN

public static final Warning EMPTY_BEGIN

When a BEGIN property value is empty (it is supposed to contain the name of a component).

EMPTY_END

public static final Warning EMPTY_END

When an END property value is empty (it is supposed to contain the name of a component).

UNMATCHED_END

public static final Warning UNMATCHED_END

When the component in an END property does not match up with any BEGIN properties.

UNKNOWN_VERSION

public static final Warning UNKNOWN_VERSION

When a VERSION property is not recognized by the parser's SyntaxRules.

UNKNOWN_CHARSET

public static final Warning UNKNOWN_CHARSET

When a property value is encoded in quoted-printable encoding and its defined character set is not recognized by the JVM.

QUOTED_PRINTABLE_ERROR

public static final Warning QUOTED_PRINTABLE_ERROR

When a property value cannot be decoded from quoted-printable encoding.

Method Detail

values

public static Warning[] 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 (Warning c : Warning.values())
    System.out.println(c);

Returns:

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

valueOf

public static Warning valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMessage

public String getMessage()

Gets a message describing the warning.

Returns:

the message

toString

public String toString()

Overrides:

toString in class Enum<Warning>