io.guise.framework.model.LocaleInfoModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation

Guise™ Internet application framework.

There is a newer version: 0.5.3

/*
 * Copyright © 2005-2008 GlobalMentor, 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 io.guise.framework.model;

import java.util.Locale;

import io.guise.framework.Guise;
import io.guise.framework.GuiseSession;

import static java.util.Objects.*;

/**
 * An info model that provides a localized version of a locale name.
 * @author Garret Wilson
 */
public class LocaleInfoModel extends DefaultInfoModel {

	/** The Guise session that owns this object. */
	private final GuiseSession session;

	/** @return The Guise session that owns this object. */
	public GuiseSession getSession() {
		return session;
	}

	/** The locale the label should represent. */
	private final Locale locale;

	/** @return The locale the label should represent. */
	public Locale getLocale() {
		return locale;
	}

	/**
	 * Constructs an info model indicating the locale to represent.
	 * @param locale The locale to be represented by the info model.
	 * @throws NullPointerException if the given locale is null.
	 */
	public LocaleInfoModel(final Locale locale) {
		this.session = Guise.getInstance().getGuiseSession(); //store a reference to the current Guise session
		this.locale = requireNonNull(locale, "Locale cannot be null"); //save the locale
	}

	@Override
	public String getLabel() {
		final String label = super.getLabel(); //get the default label
		return label != null ? label : getLocale().getDisplayName(getSession().getLocale()); //return the localized name of the locale based upon the current session locale, if no locale was explicitly set 
	}

}