org.neo4j.driver.summary.Notification Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-java-driver Show documentation
Access to the Neo4j graph database through Java
The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.neo4j.driver.summary;

import java.util.Optional;
import org.neo4j.driver.NotificationCategory;
import org.neo4j.driver.NotificationClassification;
import org.neo4j.driver.NotificationSeverity;
import org.neo4j.driver.util.Immutable;
import org.neo4j.driver.util.Preview;

/**
 * Representation for notifications found when executing a query.
 * 
 * A notification can be visualized in a client pinpointing problems or other information about the query.
 * @since 1.0
 */
@Immutable
public interface Notification extends GqlStatusObject {
    /**
     * Returns a notification code for the discovered issue.
     * @return the notification code
     */
    String code();

    /**
     * Returns a short summary of the notification.
     * @return the title of the notification.
     * @see #gqlStatus()
     */
    String title();

    /**
     * Returns a longer description of the notification.
     * @return the description of the notification.
     */
    String description();

    /**
     * The position in the query where this notification points to.
     * Not all notifications have a unique position to point to and in that case the position would be set to null.
     *
     * @return the position in the query where the issue was found, or null if no position is associated with this
     * notification.
     */
    InputPosition position();

    /**
     * Returns a position in the query where this notification points to.
     * 
     * Not all notifications have a unique position to point to and in that case an empty {@link Optional} is returned.
     *
     * @return an {@link Optional} of the {@link InputPosition} if available or an empty {@link Optional} otherwise
     * @since 5.22.0
     */
    @Preview(name = "GQL-status object")
    default Optional inputPosition() {
        return Optional.ofNullable(position());
    }

    /**
     * The severity level of the notification.
     *
     * @deprecated superseded by {@link #severityLevel()} and {@link #rawSeverityLevel()}
     * @return the severity level of the notification
     */
    @Deprecated
    default String severity() {
        return rawSeverityLevel().orElse("N/A");
    }

    /**
     * Returns the severity level of the notification derived from the diagnostic record.
     *
     * @return the severity level of the notification
     * @since 5.7
     * @see #diagnosticRecord()
     */
    default Optional severityLevel() {
        return Optional.empty();
    }

    /**
     * Returns the raw severity level of the notification as a String value retrieved directly from the diagnostic
     * record.
     *
     * @return the severity level of the notification
     * @since 5.7
     * @see #diagnosticRecord()
     */
    default Optional rawSeverityLevel() {
        return Optional.empty();
    }

    /**
     * Returns {@link NotificationClassification} derived from the diagnostic record.
     * @return an {@link Optional} of {@link NotificationClassification} or an empty {@link Optional} when the
     * classification is either absent or unrecognised
     * @since 5.22.0
     * @see #diagnosticRecord()
     */
    @Preview(name = "GQL-status object")
    default Optional classification() {
        return Optional.empty();
    }

    /**
     * Returns notification classification from the diagnostic record as a {@link String} value retrieved directly from
     * the diagnostic record.
     * @return an {@link Optional} of notification classification or an empty {@link Optional} when it is absent
     * @since 5.22.0
     * @see #diagnosticRecord()
     */
    @Preview(name = "GQL-status object")
    default Optional rawClassification() {
        return Optional.empty();
    }

    /**
     * Returns the category of the notification.
     *
     * @return the category of the notification
     * @since 5.7
     */
    default Optional category() {
        return Optional.empty();
    }

    /**
     * Returns the raw category of the notification as a String returned by the server.
     *
     * @return the category of the notification
     * @since 5.7
     */
    default Optional rawCategory() {
        return Optional.empty();
    }
}