org.neo4j.exceptions.StatusWrapCypherException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-exceptions Show documentation

Neo4j exceptions

There is a newer version: 5.23.0

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.exceptions;

import java.util.Map;
import java.util.stream.Collectors;
import org.eclipse.collections.impl.factory.Maps;
import org.neo4j.gqlstatus.ErrorGqlStatusObject;
import org.neo4j.kernel.api.exceptions.Status;

/**
 * Used to provide additional information on a Neo4jException.
 */
public class StatusWrapCypherException extends Neo4jException {
    public enum ExtraInformation {
        LINE_NUMBER,
        TRANSACTIONS_COMMITTED
    }

    private final Map extraInfoMap = Maps.mutable.of();

    public StatusWrapCypherException(Neo4jException cause) {
        super(cause.getMessage(), cause);
    }

    public StatusWrapCypherException(ErrorGqlStatusObject gqlStatusObject, Neo4jException cause) {
        super(gqlStatusObject, cause.getMessage(), cause);
    }

    public StatusWrapCypherException addExtraInfo(ExtraInformation informationType, String extraInfo) {
        extraInfoMap.put(informationType, extraInfo);
        return this;
    }

    public boolean containsInfoFor(ExtraInformation informationType) {
        return extraInfoMap.containsKey(informationType);
    }

    @Override
    public String getMessage() {
        return String.format(
                "%s (%s)",
                getCause().getMessage(),
                extraInfoMap.entrySet().stream()
                        .sorted(Map.Entry.comparingByKey())
                        .map(Map.Entry::getValue)
                        .collect(Collectors.joining(", ")));
    }

    @Override
    public Status status() {
        return ((Neo4jException) getCause()).status();
    }
}