org.neo4j.internal.schema.IndexProviderDescriptor 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.25.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;

import java.util.Objects;

/**
 * Describes the provider for a specific {@link IndexType} and version via a standard name/version string
 * 

 * PLEASE NOTE that any new name/version pairs must be added to {@link AllIndexProviderDescriptors}
 */
public class IndexProviderDescriptor {

    private final String key;
    private final String version;

    public IndexProviderDescriptor(String key, String version) {
        if (key == null) {
            throw new IllegalArgumentException("null provider key prohibited");
        }
        if (key.isEmpty()) {
            throw new IllegalArgumentException("empty provider key prohibited");
        }
        if (version == null) {
            throw new IllegalArgumentException("null provider version prohibited");
        }

        this.key = key;
        this.version = version;
    }

    public String getKey() {
        return key;
    }

    public String getVersion() {
        return version;
    }

    /**
     * @return a combination of {@link #getKey()} and {@link #getVersion()} with a '-' in between.
     */
    public String name() {
        return key + "-" + version;
    }

    @Override
    public int hashCode() {
        return Objects.hash(key, version);
    }

    @Override
    public boolean equals(Object obj) {
        if (obj != null && this.getClass() == obj.getClass()) {
            IndexProviderDescriptor otherDescriptor = (IndexProviderDescriptor) obj;
            return key.equals(otherDescriptor.getKey()) && version.equals(otherDescriptor.getVersion());
        }
        return false;
    }

    @Override
    public String toString() {
        return "{key=" + key + ", version=" + version + "}";
    }
}