1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/*
* Copyright (C) 2010, Sasa Zivkov <sasa.zivkov@sap.com>
* and other copyright owners as documented in the project's IP log.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Distribution License v1.0 which
* accompanies this distribution, is reproduced below, and is
* available at http://www.eclipse.org/org/documents/edl-v10.php
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* - Neither the name of the Eclipse Foundation, Inc. nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.eclipse.jgit.nls;
import java.util.Locale;
import java.util.concurrent.ConcurrentHashMap;
import org.eclipse.jgit.errors.TranslationBundleLoadingException;
import org.eclipse.jgit.errors.TranslationStringMissingException;
/**
* The purpose of this class is to provide NLS (National Language Support)
* configurable per thread.
*
* <p>
* The {@link #setLocale(Locale)} method is used to configure locale for the
* calling thread. The locale setting is thread inheritable. This means that a
* child thread will have the same locale setting as its creator thread until it
* changes it explicitly.
*
* <p>
* Example of usage:
*
* <pre>
* NLS.setLocale(Locale.GERMAN);
* TransportText t = NLS.getBundleFor(TransportText.class);
* </pre>
*/
public class NLS {
/** The root locale constant. It is defined here because the Locale.ROOT is not defined in Java 5 */
public static final Locale ROOT_LOCALE = new Locale("", "", ""); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
private static final InheritableThreadLocal<NLS> local = new InheritableThreadLocal<NLS>() {
@Override
protected NLS initialValue() {
return new NLS(Locale.getDefault());
}
};
/**
* Sets the locale for the calling thread.
* <p>
* The {@link #getBundleFor(Class)} method will honor this setting if if it
* is supported by the provided resource bundle property files. Otherwise,
* it will use a fall back locale as described in the
* {@link TranslationBundle}
*
* @param locale
* the preferred locale
*/
public static void setLocale(Locale locale) {
local.set(new NLS(locale));
}
/**
* Sets the JVM default locale as the locale for the calling thread.
* <p>
* Semantically this is equivalent to <code>NLS.setLocale(Locale.getDefault())</code>.
*/
public static void useJVMDefaultLocale() {
local.set(new NLS(Locale.getDefault()));
}
/**
* Returns an instance of the translation bundle of the required type. All
* public String fields of the bundle instance will get their values
* injected as described in the {@link TranslationBundle}.
*
* @param <T>
* required bundle type
* @param type
* required bundle type
* @return an instance of the required bundle type
* @exception TranslationBundleLoadingException see {@link TranslationBundleLoadingException}
* @exception TranslationStringMissingException see {@link TranslationStringMissingException}
*/
public static <T extends TranslationBundle> T getBundleFor(Class<T> type) {
return local.get().get(type);
}
final private Locale locale;
final private ConcurrentHashMap<Class, TranslationBundle> map = new ConcurrentHashMap<Class, TranslationBundle>();
private NLS(Locale locale) {
this.locale = locale;
}
@SuppressWarnings("unchecked")
private <T extends TranslationBundle> T get(Class<T> type) {
TranslationBundle bundle = map.get(type);
if (bundle == null) {
bundle = GlobalBundleCache.lookupBundle(locale, type);
// There is a small opportunity for a race, which we may
// lose. Accept defeat and return the winner's instance.
TranslationBundle old = map.putIfAbsent(type, bundle);
if (old != null)
bundle = old;
}
return (T) bundle;
}
}
|