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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
* SonarQube
* Copyright (C) 2009-2017 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program 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 3 of the License, or (at your option) any later version.
*
* This program 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 program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.utils;
import java.net.URL;
import java.time.Clock;
import java.util.Date;
import java.util.Map;
import java.util.Properties;
import java.util.TimeZone;
import javax.annotation.CheckForNull;
import org.apache.commons.lang.SystemUtils;
import org.sonar.api.batch.ScannerSide;
import org.sonar.api.ce.ComputeEngineSide;
import org.sonar.api.server.ServerSide;
/**
* Proxy over {@link java.lang.System}. It aims to improve testability of classes
* that interact with low-level system methods, for example :
* <br>
* <pre>
* public class MyClass {
* private final System2 system;
*
* public MyClass(System2 s) {
* this.system = s;
* }
*
* public long xxx() {
* return system.now();
* }
* }
*
* {@literal @}Test
* public void should_return_xxx() {
* // using Mockito
* System2 system = mock(System2.class);
* long now = 123456789L;
* doReturn(now).when(system).now();
* assertThat(new MyClass(system).xxx()).isEqualTo(now);
* }
* </pre>
* <br>
* Note that the name System2 was chosen to not conflict with {@link java.lang.System}.
* <br>
* An instance is available in IoC container since 4.3.
*
* @since 4.2
*/
@ScannerSide
@ServerSide
@ComputeEngineSide
public class System2 {
public static final System2 INSTANCE = new System2();
/**
* Shortcut for {@link System#currentTimeMillis()}
* @deprecated since 6.6 use {@link Clock} that is available in pico.
*/
@Deprecated
public long now() {
return System.currentTimeMillis();
}
/**
* Shortcut for {@link System#getProperties()}
*/
public Properties properties() {
return System.getProperties();
}
/**
* Shortcut for {@link System#getProperty(String)}
*/
@CheckForNull
public String property(String key) {
return System.getProperty(key);
}
/**
* Shortcut for {@code System{@link #setProperty(String, String)}}
* @since 6.4
*/
public System2 setProperty(String key, String value) {
System.setProperty(key, value);
return this;
}
/**
* Shortcut for {@link System#getenv()}
*/
public Map<String, String> envVariables() {
return System.getenv();
}
/**
* Shortcut for {@link System#getenv(String)}
*/
@CheckForNull
public String envVariable(String key) {
return System.getenv(key);
}
/**
* True if this is MS Windows.
*/
public boolean isOsWindows() {
return SystemUtils.IS_OS_WINDOWS;
}
/**
* True if Java 7 or Java 8 runtime environment
* @since 4.3
* @deprecated in 6.4. Java 8+ is required, so this method always returns {@code true}.
*/
@Deprecated
public boolean isJavaAtLeast17() {
return true;
}
public void println(String obj) {
System.out.print(obj);
}
/**
* @deprecated in 5.2. Please use {@link #now()}
*/
@Deprecated
public Date newDate() {
return new Date();
}
/**
* @since 5.1
* @return the JVM's default time zone
*/
public TimeZone getDefaultTimeZone() {
return TimeZone.getDefault();
}
/**
* @since 5.5
* @see Class#getResource(String)
*/
public URL getResource(String name) {
return getClass().getResource(name);
}
/**
* Closes the object and throws an {@link java.lang.IllegalStateException} on error.
* @since 5.1
*/
public void close(AutoCloseable closeable) {
try {
closeable.close();
} catch (Exception e) {
throw new IllegalStateException("Fail to close " + closeable, e);
}
}
}
|
