RegistryBuilder.java

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.hc.core5.http.config;

import java.util.HashMap;
import java.util.Map;

import org.apache.hc.core5.util.Args;
import org.apache.hc.core5.util.TextUtils;

/**
 * Builder for {@link Registry} instances.
 *
 * @param <I> the type of Registry values.
 * @since 4.3
 */
public final class RegistryBuilder<I> {

    private final Map<String, I> items;

    /**
     * Creates a new RegistryBuilder.
     *
     * @param <I> the type of Registry values.
     * @return a new RegistryBuilder.
     */
    public static <I> RegistryBuilder<I> create() {
        return new RegistryBuilder<>();
    }

    RegistryBuilder() {
        super();
        this.items = new HashMap<>();
    }

    /**
     * Registers the given item for the given ID.
     *
     * @param id The ID key, converted to lower-case.
     * @param item The item to register.
     * @return this instance.
     */
    public RegistryBuilder<I> register(final String id, final I item) {
        Args.notEmpty(id, "ID");
        Args.notNull(item, "Item");
        items.put(TextUtils.toLowerCase(id), item);
        return this;
    }

    /**
     * Creates a new Registry with the registered items.
     *
     * @return a new Registry with the registered items.
     */
    public Registry<I> build() {
        return new Registry<>(items);
    }

    @Override
    public String toString() {
        return items.toString();
    }

}