com.ocadotechnology.config.OptionalSetMultimapValueParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of OcavaCore Show documentation
There is a newer version: 16.6.21
/*
 * Copyright © 2017-2023 Ocado (Ocava)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ocadotechnology.config;

import java.util.Optional;
import java.util.function.Function;

import com.google.common.collect.ImmutableSetMultimap;

/**
 * Class to convert String config values into {@link ImmutableSetMultimap} by parsing the config value as a semicolon
 * (";") separated list of equals ("=") separated key-value pairs.
 */
public class OptionalSetMultimapValueParser {
    private final Optional parser;

    public OptionalSetMultimapValueParser(Optional parser) {
        this.parser = parser;
    }

    /**
     * @return {@link Optional#empty()} if the config value is an empty String, otherwise returns an {@link Optional}
     *          containing an {@link ImmutableSetMultimap} containing the String config value parsed as a semicolon
     *          (";") separated list of equals ("=") separated key-value pairs.  For example:
     *
     * "key1=value1;key1=value2;key2=value3"
     *
     * Keys and values will have leading and trailing whitespace trimmed.
     * Any pair which does not contain the character '=' or which starts with '=' will be ignored.
     */
    public Optional> ofStrings() {
        return withKeyAndValueParsers(Function.identity(), Function.identity());
    }

    /**
     * @return {@link Optional#empty()} if the config value is an empty String, otherwise returns an {@link Optional}
     *          containing an {@link ImmutableSetMultimap} containing the String config value parsed as a semicolon
     *          (";") separated list of equals ("=") separated key-value pairs, with each key and value converted using
     *          the supplied function.
     *
     * For example:
     *
     * "key1=value1;key1=value2;key2=value3"
     *
     * Keys and values will have leading and trailing whitespace trimmed.
     * Any pair which does not contain the character '=' or which starts with '=' will be ignored.
     *
     * @throws IllegalArgumentException   if duplicate keys are specified
     */
    public  Optional> withKeyAndValueParsers(Function keyParser, Function valueParser) {
        return parser.map(p -> p.withKeyAndValueParsers(keyParser, valueParser));
    }
}