org.neo4j.configuration.SettingImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-configuration Show documentation
Code responsible for parsing the Neo4j configuration.
There is a newer version: 5.26.0
/*
 * 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.configuration;

import static java.lang.String.format;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.neo4j.graphdb.config.Configuration;
import org.neo4j.graphdb.config.Setting;

public final class SettingImpl implements Setting {
    private final String name;
    private final SettingImpl dependency;
    private final SettingValueParser parser;
    private final T defaultValue;
    private final List> constraints;
    private final boolean dynamic;
    private final boolean immutable;
    private boolean internal;
    private String description;
    private boolean deprecated;
    private String sourceLocation;

    private SettingImpl(
            String name,
            SettingValueParser parser,
            T defaultValue,
            List> constraints,
            boolean dynamic,
            boolean immutable,
            boolean internal,
            SettingImpl dependency) {
        this.name = name;
        this.parser = parser;
        this.dependency = dependency;
        this.constraints = constraints;
        this.defaultValue = defaultValue;
        this.dynamic = dynamic;
        this.internal = internal;
        this.immutable = immutable;
    }

    public static  SettingBuilder newBuilder(String name, SettingValueParser parser, T defaultValue) {
        return SettingBuilder.newBuilder(name, parser, defaultValue);
    }

    @Override
    public T defaultValue() {
        return defaultValue;
    }

    public T parse(String value) {
        if (value == null) {
            return null;
        }

        return parser.parse(value);
    }

    public String valueToString(T value) {
        if (value != null) {
            return parser.valueToString(value);
        }
        return null;
    }

    T solveDefault(T value, T defaultValue) {
        return parser.solveDefault(value, defaultValue);
    }

    T solveDependency(T value, T dependencyValue) {
        return parser.solveDependency(value, dependencyValue);
    }

    public void validate(T value, Configuration config) {
        if (value != null) {
            if (!parser.getType().isAssignableFrom(value.getClass())) // Does only check outer class if generic types.
            {
                throw new IllegalArgumentException(format(
                        "Setting '%s' can not have value '%s'. Should be of type '%s', but is '%s'",
                        name,
                        value,
                        parser.getType().getSimpleName(),
                        value.getClass().getSimpleName()));
            }
            try {
                parser.validate(value);
                for (SettingConstraint constraint : constraints) {
                    constraint.validate(value, config);
                }
            } catch (IllegalArgumentException e) {
                throw new IllegalArgumentException(
                        format("Failed to validate '%s' for '%s': %s", value, name(), e.getMessage()), e);
            }
        }
    }

    @Override
    public String toString() {
        return format("%s, %s", name, validValues(false));
    }

    public String validValues() {
        return validValues(true);
    }

    private String validValues(boolean capitalize) {
        String desc = parser.getDescription();

        if (!constraints.isEmpty()) {
            String constraintDesc =
                    constraints.stream().map(SettingConstraint::getDescription).collect(Collectors.joining(" and "));
            desc += parser.constraintConjunction() + constraintDesc;
        }

        if (dependency != null) {
            desc = format("%s. %s from %s", desc, parser.getSolverDescription(), dependency.name());
        }

        desc += ".";

        if (capitalize) {
            return StringUtils.capitalize(desc);
        } else {
            return desc;
        }
    }

    public SettingImpl dependency() {
        return dependency;
    }

    public List> constraints() {
        return Collections.unmodifiableList(constraints);
    }

    @Override
    public String description() {
        return description != null ? description : toString();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        SettingImpl setting = (SettingImpl) o;
        return name.equals(setting.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name);
    }

    @Override
    public String name() {
        return name;
    }

    @Override
    public boolean dynamic() {
        return dynamic;
    }

    public boolean immutable() {
        return immutable;
    }

    public boolean internal() {
        return internal;
    }

    public boolean deprecated() {
        return deprecated;
    }

    public String sourceLocation() {
        return sourceLocation;
    }

    void setDescription(String description) {
        this.description = description;
    }

    void setInternal() {
        internal = true;
    }

    void setDeprecated() {
        deprecated = true;
    }

    void setSourceLocation(String sourceLocation) {
        this.sourceLocation = sourceLocation;
    }

    public SettingValueParser parser() {
        return parser;
    }

    public static class Builder implements SettingBuilder {
        private final String name;
        private final SettingValueParser parser;
        private final List> constraints = new ArrayList<>();
        private final T defaultValue;
        private boolean dynamic;
        private boolean immutable;
        private boolean internal;
        private SettingImpl dependency;

        Builder(String name, SettingValueParser parser, T defaultValue) {
            this.name = name;
            this.parser = parser;
            this.defaultValue = defaultValue;
        }

        @Override
        public Builder dynamic() {
            this.dynamic = true;
            return this;
        }

        @Override
        public Builder immutable() {
            this.immutable = true;
            return this;
        }

        @Override
        public Builder internal() {
            this.internal = true;
            return this;
        }

        @Override
        public Builder addConstraint(SettingConstraint constraint) {
            constraint.setParser(parser);
            constraints.add(constraint);
            return this;
        }

        @Override
        public Builder setDependency(Setting setting) {
            dependency = (SettingImpl) setting;
            return this;
        }

        @Override
        public Setting build() {
            if (immutable && dynamic) {
                throw new IllegalArgumentException("Setting can not be both dynamic and immutable");
            }
            if (dependency != null && !dependency.immutable()) {
                throw new IllegalArgumentException("Setting can only have immutable dependency");
            }

            return new SettingImpl<>(name, parser, defaultValue, constraints, dynamic, immutable, internal, dependency);
        }
    }
}