org.neo4j.internal.schema.constraints.IndexBackedConstraintDescriptor Maven / Gradle / Ivy

Go to download

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

Schema descriptors and interfaces in Neo4j.

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.internal.schema.constraints;

import org.neo4j.internal.schema.ConstraintDescriptor;
import org.neo4j.internal.schema.IndexType;

public interface IndexBackedConstraintDescriptor extends ConstraintDescriptor {
    /**
     * @return {@code true} if this constraint has a backing index, and calling {@link #ownedIndexId()} will not throw.
     */
    boolean hasOwnedIndexId();

    /**
     * Return the id of the index that is owned by this constraint, if any, or throw an {@link IllegalStateException}.
     * @return the id of the index backing this constraint.
     */
    long ownedIndexId();

    /**
     * Return the type of the index that is owned by this constraint, if any, or throw an {@link IllegalStateException}.
     * @return the type of the index backing this constraint.
     */
    IndexType indexType();
}