Package com.hexaly.optimizer

Enum Class HxErrorCode

java.lang.Object

java.lang.Enum<HxErrorCode>

com.hexaly.optimizer.HxErrorCode

All Implemented Interfaces:

Serializable, Comparable<HxErrorCode>, Constable

public enum HxErrorCode
extends Enum<HxErrorCode>

List of error codes used by HxException.

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
Api	Code used for errors related to API functions.
Callback	Code used when an error is encountered in a user callback.
Cloud	Code used when an error is encountered while using the cloud service.
File	Code used when an error related to input/output operations occurs.
Internal	Internal Hexaly error.
License	Code used when a problem related to licensing occurs.
Model	Code used when a problem related to the structure of the model occurs.
Modeler	Code used when an error is encountered in the modeler.
Solver	Code used when a problem occurs during the resolution.

Method Summary

Modifier and Type	Method	Description
static HxErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HxErrorCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Api

public static final HxErrorCode Api

Code used for errors related to API functions. Used when you call a function in a wrong way or with inappropriate parameters. Examples of error messages:

• Argument 'argName' cannot be null.
• Argument 'argName' does not belong to this instance of Hexaly Optimizer.
• Argument 'argName' must be positive.
• Argument 'argName' cannot be an empty String.
• This method is only allowed in state Modeling (the model must not be closed).

File

public static final HxErrorCode File

Code used when an error related to input/output operations occurs. Examples of error messages:

• File doesn't exist.
• File is corrupted.
• Cannot open file.
• File format is not recognized.

Model

public static final HxErrorCode Model

Code used when a problem related to the structure of the model occurs. Examples of error messages:

• At least one objective is required in the model.
• A cycle of length 'n' was detected in the model.
• Number of operands ('n') is too small: at least 'm' operands are expected for 'operator'.
• Operand 'n' of 'operator' must be 'type'. Type provided: 'otherType'.

Callback

public static final HxErrorCode Callback

Code used when an error is encountered in a user callback.

License

public static final HxErrorCode License

Code used when a problem related to licensing occurs. That could be a problem with the license itself (expiration, hardware signature, etc.), or a problem related to input/output or networking operations. Examples of error messages:

• Incorrect license number.
• This license key is not compatible with the current hardware. Please contact your reseller.
• Property prop is missing in file [file]
• Fail to contact the token server. Check your connection.
• This license is not compatible with the current hardware.
• No token available. All tokens are currently in use.

Solver

public static final HxErrorCode Solver

Code used when a problem occurs during the resolution.

Internal

public static final HxErrorCode Internal

Internal Hexaly error.

Modeler

public static final HxErrorCode Modeler

Code used when an error is encountered in the modeler.

Cloud

public static final HxErrorCode Cloud

Code used when an error is encountered while using the cloud service.

Method Details

values

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