com.phloc.commons.text.IMultiLingualText 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 java.util.Locale;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.phloc.commons.callback.IChangeNotify;
import com.phloc.commons.state.EChange;
import com.phloc.commons.state.IClearable;
/**
* Interface for a writable version of a multilingual text
*
* @author Philip Helger
*/
public interface IMultiLingualText extends IReadonlyMultiLingualText, IClearable
{
/**
* Add a text in the specified locale. If a text with the same locale is
* already present, false is returned.
*
* @param aContentLocale
* The locale in which the text should be set. May not be
* null.
* @param sText
* The text to be set. May be null.
* @return {@link EChange#CHANGED} if the text was added,
* {@link EChange#UNCHANGED} otherwise.
*/
@Nonnull
EChange addText (@Nonnull Locale aContentLocale, @Nullable String sText);
/**
* Set a text in the specified locale. If a text with the same locale is
* already present, the old value is overwritten.
*
* @param aContentLocale
* The locale in which the text should be set. May not be
* null .
* @param sText
* The text to be set. May be null.
* @return {@link EChange#CHANGED} if the text was set,
* {@link EChange#UNCHANGED} otherwise.
*/
@Nonnull
EChange setText (@Nonnull Locale aContentLocale, @Nullable String sText);
/**
* Remove the text with the specified locale.
*
* @param aContentLocale
* The locale to be removed. May not be null.
* @return {@link EChange#CHANGED} if the text was remove,
* {@link EChange#UNCHANGED} otherwise.
*/
@Nonnull
EChange removeText (@Nonnull Locale aContentLocale);
/**
* Assign all fields from the passed object. All existing texts are removed!
*
* @param aMLT
* The object to read the content from. May not be null.
* @return {@link EChange#CHANGED} if the assignment changed anything,
* {@link EChange#UNCHANGED} otherwise.
*/
@Nonnull
EChange assignFrom (@Nonnull IReadonlyMultiLingualText aMLT);
/**
* Add a notification callback that is called, when the object is changed.
*
* @param aCallback
* The callback to add. May not be null.
*/
void addChangeNotifier (@Nonnull IChangeNotify aCallback);
}