001/*
002 * Copyright 2002-2013 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.TimeZone;
020
021import org.springframework.lang.Nullable;
022
023/**
024 * Extension of {@link LocaleContext}, adding awareness of the current time zone.
025 *
026 * <p>Having this variant of LocaleContext set to {@link LocaleContextHolder} means
027 * that some TimeZone-aware infrastructure has been configured, even if it may not
028 * be able to produce a non-null TimeZone at the moment.
029 *
030 * @author Juergen Hoeller
031 * @author Nicholas Williams
032 * @since 4.0
033 * @see LocaleContextHolder#getTimeZone()
034 */
035public interface TimeZoneAwareLocaleContext extends LocaleContext {
036
037        /**
038         * Return the current TimeZone, which can be fixed or determined dynamically,
039         * depending on the implementation strategy.
040         * @return the current TimeZone, or {@code null} if no specific TimeZone associated
041         */
042        @Nullable
043        TimeZone getTimeZone();
044
045}