com.phloc.commons.IHasLocales Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* 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 com.phloc.commons;
import java.util.Collection;
import java.util.Locale;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Base interface for objects having zero or more locales.
*
* @author Philip Helger
*/
public interface IHasLocales
{
/**
* @return The locales of this object. May not be null.
*/
@Nonnull
Collection getAllLocales ();
/**
* @return The number of contained locales. Always ≥ 0.
*/
@Nonnegative
int getLocaleCount ();
/**
* Check if the passed locale is directly contained.
*
* @param aLocale
* The locale to check. May be null.
* @return true if the locale is directly contained,
* false if not.
*/
boolean containsLocale (@Nullable Locale aLocale);
/**
* Check if the passed locale is directly or by fallback contained. The
* implementation class MUST add locale-generalisation when resolving the text
* ("de_DE" => "de" => default).
*
* @param aLocale
* The locale to check. May be null.
* @return true if the locale is contained, false if
* not.
*/
boolean containsLocaleWithFallback (@Nullable Locale aLocale);
}