123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 |
- /*
- * 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.interfaces.config;
-
- import com.dmdirc.config.ConfigFileBackedConfigProvider;
-
- import com.dmdirc.config.provider.AggregateConfigProvider;
- import com.dmdirc.config.provider.ConfigProvider;
- import java.util.Collection;
-
- /**
- * Defines the interface implemented by the object in charge of DMDirc's identities.
- */
- public interface IdentityController {
-
- /**
- * Retrieves the identity used for addons defaults.
- *
- * @return The addons defaults identity
- */
- ConfigProvider getAddonSettings();
-
- /**
- * Retrieves the identity used for the global config.
- *
- * @return The global config identity
- */
- ConfigProvider getUserSettings();
-
- /**
- * Retrieves the global config manager.
- *
- * @return The global config manager
- */
- AggregateConfigProvider getGlobalConfiguration();
-
- /**
- * Retrieves the identity bundled with the DMDirc client containing version information.
- *
- * @return The version identity
- *
- * @since 0.6.3m2
- */
- ReadOnlyConfigProvider getVersionSettings();
-
- /**
- * Retrieves a list of identities that belong to the specified custom type.
- *
- * @param type The type of identity to search for
- *
- * @return A list of matching identities
- *
- * @since 0.6.4
- */
- Collection<ConfigProvider> getProvidersByType(String type);
-
- /**
- * Loads user-defined identity files.
- */
- void loadUserIdentities();
-
- /**
- * Loads the version information.
- */
- void loadVersionIdentity();
-
- /**
- * Adds the specific identity to this manager.
- *
- * @param identity The identity to be added
- */
- void addConfigProvider(final ConfigFileBackedConfigProvider identity);
-
- /**
- * Saves all modified identity files to disk.
- */
- void saveAll();
-
- /**
- * Removes an identity from this manager.
- *
- * @param identity The identity to be removed
- */
- void removeConfigProvider(final ConfigFileBackedConfigProvider identity);
-
- }
|