org.gatein.api.common.LocalizedDisplayable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gatein-api

There is a newer version: 1.1.0.Final

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.gatein.api.common;

import java.util.Locale;

import org.gatein.api.common.i18n.LocalizedString;

/**
 * Provides a UI friendly that supports localization
 * 
 * @author Nick Scavelli
 * @author Stian Thorgersen
 */
public interface LocalizedDisplayable extends Displayable {
    /**
     * Returns a localized string that can represent a single non localized name or many values each mapping to a specific
     * {@link Locale}
     * 
     * @return the localized string
     */
    LocalizedString getDisplayNames();

    /**
     * Sets the display name
     * 
     * @param displayName the display name
     */
    void setDisplayNames(LocalizedString displayName);
}