InputException#

Thrown when the data or options passed to a call are invalid. The call leaves the project state as it was. InputException extends PlenException, so catch (PlenException e) also catches it. It's unchecked, and no method declares it in throws. The engine creates it; code rarely constructs one directly.

Declaration#

package org.dhtmlx.plen;

public class InputException extends PlenException {
  public InputException(InputErrorKind kind, String message, String path)
  public InputException(InputErrorKind kind, String message)
  public static InputException validation(String path, String message)

  public InputErrorKind kind;
  public String path;

  public InputException withKind(InputErrorKind value)
  public InputException withPath(String value)
}

Constructors#

InputException#

public InputException(InputErrorKind kind, String message, String path)
public InputException(InputErrorKind kind, String message)

Creates an input error. The two-argument form sets path to null.

Fields#

kind#

public InputErrorKind kind

PARSE when the input couldn't be decoded, VALIDATION when it decoded but is invalid. See InputErrorKind for which calls produce each.

path#

public String path

The field the error refers to, in its JSON (wire) spelling with snake_case names and zero-based indexes: tasks[3].constraint_date, scope.resources, slots[2].value, newResourcePenalty. It's null for parse errors and when the error concerns the whole state rather than one field, such as Project#suggestAssignments on a cyclic project.

Methods#

getMessage#

public String getMessage()

Inherited from Throwable. Returns the description alone, without the path or kind. Read path as well when showing the error to a user.

withKind#

public InputException withKind(InputErrorKind value)

Sets kind and returns this exception.

withPath#

public InputException withPath(String value)

Sets path and returns this exception.

Static methods#

validation#

public static InputException validation(String path, String message)

Creates an error with kind set to VALIDATION.

Returns the new InputException.

Thrown by#

Project#apply doesn't throw it: rejected operations come back in ApplyReport.rejected. SkillLayer.slots throws MatchException instead; MatchException.Invalid#toPlenException() converts it to an InputException of kind VALIDATION. The validation rules for project data are on ProjectData. The Validation mode decides whether fixable input is rejected or repaired.

InputErrorKind#

The kind of an InputException.

package org.dhtmlx.plen;

public enum InputErrorKind {
  PARSE,
  VALIDATION
}

Example#

import java.util.List;
import org.dhtmlx.plen.*;

public class InputErrorExample {
  public static void main(String[] args) throws Exception {
    Moment monday = Moment.fromYmdHm(2026, 3, 2, 8, 0);

    ProjectData data = new ProjectData()
        .withTasks(List.of(
            new TaskData(Id.str("ok")).withStartDate(monday).withDuration(1.0),
            // only one of start, end and duration
            new TaskData(Id.str("broken")).withDuration(2.0)));

    try {
      Engine.schedule(data, new SolveOptions());
    } catch (InputException e) {
      if (e.kind == InputErrorKind.VALIDATION) {
        String where = e.path != null ? e.path : "(input)";
        System.out.println(where + ": " + e.getMessage());
      }
    }
  }
}

Related#

• PlenException - the base class
• ProjectException - the error for a call that doesn't fit the project state
• ProjectData - the validation rules for project data
• Validation - repair fixable input instead of rejecting it
• Error handling - reporting a validation error with its path