I18nProvider.java

/*
 * Copyright (C) 2013 Google Inc.
 *
 * 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 interactivespaces.util.i18n;

import interactivespaces.InteractiveSpacesException;

import java.util.Locale;
import java.util.Set;

/**
 * Provide internationalization sources.
 *
 * @author Keith M. Hughes
 */
public interface I18nProvider {

  /**
   * Get the locales supported by the provider.
   *
   * @return the locales supported by the provider
   */
  Set<Locale> getSupportedLocales();

  /**
   * Get all supported sources from the provider.
   *
   * @return all supported sources from the provider
   */
  Set<I18nSource> getAllSupportedSources();

  /**
   * Get an internalization source for a particular language.
   *
   * @param locale
   *          the locale the source should be in
   *
   * @return the source
   *
   * @throws InteractiveSpacesException
   *           if no appropriate internationalization was found
   */
  I18nSource getSource(Locale locale);
}