org.neo4j.capabilities.Capabilities Maven / Gradle / Ivy

Go to download
/*
 * 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.capabilities;

/**
 * Provides users access to declared capability values.
 */
public interface Capabilities {
    /**
     * Gets a capability value identified by the provided capability declaration.
     *
     * @param capability the capability that is being queried.
     * @param         the type of the capability value.
     * @return the capability value set, or null if it is not in the set of declared capabilities.
     */
     T get(Capability capability);

    /**
     * Gets a capability value identified by the provided capability declaration.
     *
     * @param name the name of the capability that is being queried.
     * @return the capability value set, or null if it is not in the set of declared capabilities.
     */
    Object get(Name name);
}