com.phloc.commons.text.IPredefinedLocaleTextProvider 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.text;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
/**
* Specialized {@link com.phloc.commons.text.ITextProvider}-like interface that
* gives support for resolving a text without manually passing in a locale.
*
* @author Philip Helger
*/
public interface IPredefinedLocaleTextProvider
{
/**
* @return The same as
* {@link com.phloc.commons.text.ITextProvider#getText(java.util.Locale)}
* in the predefined locale.
*/
@Nullable
String getText ();
/**
* @param aArgs
* The arguments to be added into the string. May not be
* null.
* @return The same as
* {@link com.phloc.commons.text.ITextProvider#getTextWithArgs(java.util.Locale, Object...)}
* in the predefined locale.
*/
@Nullable
String getTextWithArgs (@Nonnull Object... aArgs);
}