DMDirc-Client/api/src/main/java/com/dmdirc/config/profiles/ProfileStore.java

/*
 * Copyright (c) 2006-2017 DMDirc Developers
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.dmdirc.config.profiles;

import java.util.Collection;

/**
 * A store of {@link Profile}s that can read and write them to some kind of persistent media.
 */
public interface ProfileStore {

    /**
     * Reads and returns all profiles from within the store.
     *
     * @return A set of known profiles, or an empty set if the store is uninitialised.
     */
    Collection<Profile> readProfiles();

    /**
     * Writes all the given profiles to the store, replacing any existing commands.
     *
     * @param profiles The collection of profiles to be written to the store.
     */
    void writeProfiles(Collection<Profile> profiles);

}