001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.context.i18n;
018
019import java.util.Locale;
020
021import org.springframework.lang.Nullable;
022
023/**
024 * Simple implementation of the {@link LocaleContext} interface,
025 * always returning a specified {@code Locale}.
026 *
027 * @author Juergen Hoeller
028 * @since 1.2
029 * @see LocaleContextHolder#setLocaleContext
030 * @see LocaleContextHolder#getLocale()
031 * @see SimpleTimeZoneAwareLocaleContext
032 */
033public class SimpleLocaleContext implements LocaleContext {
034
035        @Nullable
036        private final Locale locale;
037
038
039        /**
040         * Create a new SimpleLocaleContext that exposes the specified Locale.
041         * Every {@link #getLocale()} call will return this Locale.
042         * @param locale the Locale to expose, or {@code null} for no specific one
043         */
044        public SimpleLocaleContext(@Nullable Locale locale) {
045                this.locale = locale;
046        }
047
048        @Override
049        @Nullable
050        public Locale getLocale() {
051                return this.locale;
052        }
053
054        @Override
055        public String toString() {
056                return (this.locale != null ? this.locale.toString() : "-");
057        }
058
059}