/*
 * WorldGuard, a suite of tools for Minecraft
 * Copyright (C) sk89q <http://www.sk89q.com>
 * Copyright (C) WorldGuard team and contributors
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package com.sk89q.worldguard.domains.registry;

import com.sk89q.worldguard.domains.CustomDomain;

import javax.annotation.Nullable;
import java.util.List;
import java.util.Map;

public interface DomainRegistry extends Iterable<DomainFactory<?>> {

    /**
     * Register a new Domain
     *
     * <p>There may be an appropiate time to register domains. if domains are
     * registered outside this time, then an exception may be thrown.</p>
     *
     * @param domain The domain
     * @throws DomainConflictException Thrown when already an existing domain exists with the same name
     * @throws IllegalStateException If it is not the right time to register new domains
     */
    void register(String name, DomainFactory<?> domain) throws DomainConflictException;

    /**
     * Register a collection of domains.
     *
     * <p>There may be an appropriate time to register domains. If domains are
     * registered outside this time, then an exception may be thrown.</p>
     *
     * <p>If there is a domain conflict, then an error will be logged but
     * no exception will be thrown.</p>
     *
     * @param domains a collection of domain factories
     * @throws IllegalStateException If it is not the right time to register new domains
     */
    void registerAll(Map<String, DomainFactory<?>> domains);

    /**
     * Get the domain by its name.
     *
     * @param name The name
     * @return The domain, if it has been registered
     */
    @Nullable
    DomainFactory<?> get(String name);

    /**
     * Try to get a domain by its name
     */
    @Nullable
    CustomDomain createDomain(String name);

    /**
     * Get all domains keyed by the registered name
     *
     * @return All domains
     */
    Map<String, DomainFactory<?>> getAll();

    /**
     * Unmarshal a raw map of values into a list of domains with their
     * unmarshalled values.
     *
     * @param rawValues The raw values map
     * @param createUnknown Whether "just in time" domains should be created for unknown domains
     * @return The unmarshalled domain list
     */
    Map<String, CustomDomain> unmarshal(Map<String, Object> rawValues, boolean createUnknown);

    /**
     * Get the number of registered domains.
     *
     * @return The number of registered domains
     */
    int size();
}