org.neo4j.driver.summary.InputPosition 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 org.neo4j.driver.util.Immutable;

/**
 * An input position refers to a specific character in a query.
 * @since 1.0
 */
@Immutable
public interface InputPosition {
    /**
     * The character offset referred to by this position; offset numbers start at 0.
     *
     * @return the offset of this position.
     */
    int offset();

    /**
     * The line number referred to by the position; line numbers start at 1.
     *
     * @return the line number of this position.
     */
    int line();

    /**
     * The column number referred to by the position; column numbers start at 1.
     *
     * @return the column number of this position.
     */
    int column();
}