org.neo4j.notifications.StandardGqlStatusObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-notifications Show documentation
Neo4j errors, info and warnings notifications
There is a newer version: 5.26.1
/*
 * 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.notifications;

import java.util.Arrays;
import java.util.HashSet;
import org.neo4j.gqlstatus.CommonGqlStatusObjectImplementation;
import org.neo4j.gqlstatus.DiagnosticRecord;
import org.neo4j.gqlstatus.GqlStatusInfoCodes;
import org.neo4j.graphdb.GqlStatusObject;

public class StandardGqlStatusObject extends CommonGqlStatusObjectImplementation implements GqlStatusObject {

    public static final StandardGqlStatusObject SUCCESS = new StandardGqlStatusObject(GqlStatusInfoCodes.STATUS_00000);
    public static final StandardGqlStatusObject NO_DATA = new StandardGqlStatusObject(GqlStatusInfoCodes.STATUS_02000);
    public static final StandardGqlStatusObject UNKNOWN_NO_DATA =
            new StandardGqlStatusObject(GqlStatusInfoCodes.STATUS_02N42);
    public static final StandardGqlStatusObject OMITTED_RESULT =
            new StandardGqlStatusObject(GqlStatusInfoCodes.STATUS_00001);

    public static final HashSet STANDARD_GQL_STATUS_CODES = new HashSet<>(Arrays.asList(
            NO_DATA.gqlStatus(), SUCCESS.gqlStatus(), OMITTED_RESULT.gqlStatus(), UNKNOWN_NO_DATA.gqlStatus()));

    StandardGqlStatusObject(GqlStatusInfoCodes gqlStatusInfo) {
        super(gqlStatusInfo, new DiagnosticRecord());
    }

    @Override
    public String toString() {
        if (this == SUCCESS) {
            return "SUCCESS";
        }
        if (this == NO_DATA) {
            return "NO DATA";
        }
        if (this == UNKNOWN_NO_DATA) {
            return "UNKNOWN NO DATA";
        }
        if (this == OMITTED_RESULT) {
            return "OMITTED RESULT";
        }
        return String.format("GqlStatusObject with GQLSTATUS %s", gqlStatusInfo.getStatusString());
    }

    public static boolean isStandardGqlStatusCode(GqlStatusObject gso) {
        return gso == StandardGqlStatusObject.NO_DATA
                || gso == StandardGqlStatusObject.SUCCESS
                || gso == StandardGqlStatusObject.OMITTED_RESULT
                || gso == StandardGqlStatusObject.UNKNOWN_NO_DATA;
    }

    public static boolean isStandardGqlStatusCode(String gqlStatus) {
        return STANDARD_GQL_STATUS_CODES.contains(gqlStatus);
    }
}