org.neo4j.gds.config.BaseConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config-api Show documentation

Neo4j Graph Data Science :: Config API

The newest version!

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://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.gds.config;

import org.neo4j.gds.annotation.Configuration;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;

public interface BaseConfig extends ToMapConvertible {

    String SUDO_KEY = "sudo";
    String LOG_PROGRESS_KEY = "logProgress";

    @Configuration.Key("username")
    @Configuration.ConvertWith(method = "trim")
    Optional usernameOverride();

    @Configuration.Key(SUDO_KEY)
    default boolean sudo() {
        return false;
    }

    @Configuration.Key(LOG_PROGRESS_KEY)
    default boolean logProgress() {
        return true;
    }

    @Configuration.CollectKeys
    default Collection configKeys() {
        return Collections.emptyList();
    }

    @Configuration.ToMap
    default Map toMap() {
        return new HashMap<>();
    }

    static String trim(String input) {
        return input.trim();
    }
}