Skip to content

Commit cc106a1

Browse files
harawataharawata
authored
Merge pull request #1329 from wxisme/fix-comments
Converting normal comments to Javadoc comments. This partly reverts e8cc000
2 parents 915f86a + ec8c268 commit cc106a1

File tree

12 files changed

+89
-89
lines changed

12 files changed

+89
-89
lines changed

‎src/main/java/org/apache/ibatis/builder/xml/XMLMapperEntityResolver.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2016 the original author or authors.
2+
* Copyright 2009-2018 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ public class XMLMapperEntityResolver implements EntityResolver {
4040
private static final String MYBATIS_CONFIG_DTD = "org/apache/ibatis/builder/xml/mybatis-3-config.dtd";
4141
private static final String MYBATIS_MAPPER_DTD = "org/apache/ibatis/builder/xml/mybatis-3-mapper.dtd";
4242

43-
/*
43+
/**
4444
* Converts a public DTD into a local one
4545
*
4646
* @param publicId The public id that is what comes after "PUBLIC"

‎src/main/java/org/apache/ibatis/datasource/pooled/PooledConnection.java

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2017 the original author or authors.
2+
* Copyright 2009-2018 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -41,7 +41,7 @@ class PooledConnection implements InvocationHandler {
4141
private int connectionTypeCode;
4242
private boolean valid;
4343

44-
/*
44+
/**
4545
* Constructor for SimplePooledConnection that uses the Connection and PooledDataSource passed in
4646
*
4747
* @param connection - the connection that is to be presented as a pooled connection
@@ -57,14 +57,14 @@ public PooledConnection(Connection connection, PooledDataSource dataSource) {
5757
this.proxyConnection = (Connection) Proxy.newProxyInstance(Connection.class.getClassLoader(), IFACES, this);
5858
}
5959

60-
/*
60+
/**
6161
* Invalidates the connection
6262
*/
6363
public void invalidate() {
6464
valid = false;
6565
}
6666

67-
/*
67+
/**
6868
* Method to see if the connection is usable
6969
*
7070
* @return True if the connection is usable
@@ -73,7 +73,7 @@ public boolean isValid() {
7373
return valid && realConnection != null && dataSource.pingConnection(this);
7474
}
7575

76-
/*
76+
/**
7777
* Getter for the *real* connection that this wraps
7878
*
7979
* @return The connection
@@ -82,7 +82,7 @@ public Connection getRealConnection() {
8282
return realConnection;
8383
}
8484

85-
/*
85+
/**
8686
* Getter for the proxy for the connection
8787
*
8888
* @return The proxy
@@ -91,7 +91,7 @@ public Connection getProxyConnection() {
9191
return proxyConnection;
9292
}
9393

94-
/*
94+
/**
9595
* Gets the hashcode of the real connection (or 0 if it is null)
9696
*
9797
* @return The hashcode of the real connection (or 0 if it is null)
@@ -100,7 +100,7 @@ public int getRealHashCode() {
100100
return realConnection == null ? 0 : realConnection.hashCode();
101101
}
102102

103-
/*
103+
/**
104104
* Getter for the connection type (based on url + user + password)
105105
*
106106
* @return The connection type
@@ -109,7 +109,7 @@ public int getConnectionTypeCode() {
109109
return connectionTypeCode;
110110
}
111111

112-
/*
112+
/**
113113
* Setter for the connection type
114114
*
115115
* @param connectionTypeCode - the connection type
@@ -118,7 +118,7 @@ public void setConnectionTypeCode(int connectionTypeCode) {
118118
this.connectionTypeCode = connectionTypeCode;
119119
}
120120

121-
/*
121+
/**
122122
* Getter for the time that the connection was created
123123
*
124124
* @return The creation timestamp
@@ -127,7 +127,7 @@ public long getCreatedTimestamp() {
127127
return createdTimestamp;
128128
}
129129

130-
/*
130+
/**
131131
* Setter for the time that the connection was created
132132
*
133133
* @param createdTimestamp - the timestamp
@@ -136,7 +136,7 @@ public void setCreatedTimestamp(long createdTimestamp) {
136136
this.createdTimestamp = createdTimestamp;
137137
}
138138

139-
/*
139+
/**
140140
* Getter for the time that the connection was last used
141141
*
142142
* @return - the timestamp
@@ -145,7 +145,7 @@ public long getLastUsedTimestamp() {
145145
return lastUsedTimestamp;
146146
}
147147

148-
/*
148+
/**
149149
* Setter for the time that the connection was last used
150150
*
151151
* @param lastUsedTimestamp - the timestamp
@@ -154,7 +154,7 @@ public void setLastUsedTimestamp(long lastUsedTimestamp) {
154154
this.lastUsedTimestamp = lastUsedTimestamp;
155155
}
156156

157-
/*
157+
/**
158158
* Getter for the time since this connection was last used
159159
*
160160
* @return - the time since the last use
@@ -163,7 +163,7 @@ public long getTimeElapsedSinceLastUse() {
163163
return System.currentTimeMillis() - lastUsedTimestamp;
164164
}
165165

166-
/*
166+
/**
167167
* Getter for the age of the connection
168168
*
169169
* @return the age
@@ -172,7 +172,7 @@ public long getAge() {
172172
return System.currentTimeMillis() - createdTimestamp;
173173
}
174174

175-
/*
175+
/**
176176
* Getter for the timestamp that this connection was checked out
177177
*
178178
* @return the timestamp
@@ -181,7 +181,7 @@ public long getCheckoutTimestamp() {
181181
return checkoutTimestamp;
182182
}
183183

184-
/*
184+
/**
185185
* Setter for the timestamp that this connection was checked out
186186
*
187187
* @param timestamp the timestamp
@@ -190,7 +190,7 @@ public void setCheckoutTimestamp(long timestamp) {
190190
this.checkoutTimestamp = timestamp;
191191
}
192192

193-
/*
193+
/**
194194
* Getter for the time that this connection has been checked out
195195
*
196196
* @return the time
@@ -204,7 +204,7 @@ public int hashCode() {
204204
return hashCode;
205205
}
206206

207-
/*
207+
/**
208208
* Allows comparing this connection to another
209209
*
210210
* @param obj - the other connection to test for equality
@@ -221,7 +221,7 @@ public boolean equals(Object obj) {
221221
}
222222
}
223223

224-
/*
224+
/**
225225
* Required for InvocationHandler implementation.
226226
*
227227
* @param proxy - not used

‎src/main/java/org/apache/ibatis/datasource/pooled/PooledDataSource.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ public void setDriverProperties(Properties driverProps) {
150150
forceCloseAll();
151151
}
152152

153-
/*
153+
/**
154154
* The maximum number of active connections
155155
*
156156
* @param poolMaximumActiveConnections The maximum number of active connections
@@ -160,7 +160,7 @@ public void setPoolMaximumActiveConnections(int poolMaximumActiveConnections) {
160160
forceCloseAll();
161161
}
162162

163-
/*
163+
/**
164164
* The maximum number of idle connections
165165
*
166166
* @param poolMaximumIdleConnections The maximum number of idle connections
@@ -170,7 +170,7 @@ public void setPoolMaximumIdleConnections(int poolMaximumIdleConnections) {
170170
forceCloseAll();
171171
}
172172

173-
/*
173+
/**
174174
* The maximum number of tolerance for bad connection happens in one thread
175175
* which are applying for new {@link PooledConnection}
176176
*
@@ -184,7 +184,7 @@ public void setPoolMaximumLocalBadConnectionTolerance(
184184
this.poolMaximumLocalBadConnectionTolerance = poolMaximumLocalBadConnectionTolerance;
185185
}
186186

187-
/*
187+
/**
188188
* The maximum time a connection can be used before it *may* be
189189
* given away again.
190190
*
@@ -195,7 +195,7 @@ public void setPoolMaximumCheckoutTime(int poolMaximumCheckoutTime) {
195195
forceCloseAll();
196196
}
197197

198-
/*
198+
/**
199199
* The time to wait before retrying to get a connection
200200
*
201201
* @param poolTimeToWait The time to wait
@@ -205,7 +205,7 @@ public void setPoolTimeToWait(int poolTimeToWait) {
205205
forceCloseAll();
206206
}
207207

208-
/*
208+
/**
209209
* The query to be used to check a connection
210210
*
211211
* @param poolPingQuery The query
@@ -215,7 +215,7 @@ public void setPoolPingQuery(String poolPingQuery) {
215215
forceCloseAll();
216216
}
217217

218-
/*
218+
/**
219219
* Determines if the ping query should be used.
220220
*
221221
* @param poolPingEnabled True if we need to check a connection before using it
@@ -225,7 +225,7 @@ public void setPoolPingEnabled(boolean poolPingEnabled) {
225225
forceCloseAll();
226226
}
227227

228-
/*
228+
/**
229229
* If a connection has not been used in this many milliseconds, ping the
230230
* database to make sure the connection is still good.
231231
*
@@ -497,7 +497,7 @@ private PooledConnection popConnection(String username, String password) throws
497497
return conn;
498498
}
499499

500-
/*
500+
/**
501501
* Method to check to see if a connection is still usable
502502
*
503503
* @param conn - the connection to check
@@ -551,7 +551,7 @@ protected boolean pingConnection(PooledConnection conn) {
551551
return result;
552552
}
553553

554-
/*
554+
/**
555555
* Unwraps a pooled connection to get to the 'real' connection
556556
*
557557
* @param conn - the pooled connection to unwrap

‎src/main/java/org/apache/ibatis/executor/BatchExecutorException.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2017 the original author or authors.
2+
* Copyright 2009-2018 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -43,7 +43,7 @@ public BatchExecutorException(String message,
4343
this.batchResult = batchResult;
4444
}
4545

46-
/*
46+
/**
4747
* Returns the BatchUpdateException that caused the nested executor
4848
* to fail. That exception contains an array of row counts
4949
* that can be used to determine exactly which statement of the
@@ -55,7 +55,7 @@ public BatchUpdateException getBatchUpdateException() {
5555
return batchUpdateException;
5656
}
5757

58-
/*
58+
/**
5959
* Returns a list of BatchResult objects. There will be one entry
6060
* in the list for each successful sub-executor executed before the failing
6161
* executor.
@@ -67,7 +67,7 @@ public List<BatchResult> getSuccessfulBatchResults() {
6767
return successfulBatchResults;
6868
}
6969

70-
/*
70+
/**
7171
* Returns the SQL statement that caused the failure
7272
* (not the parameterArray)
7373
*
@@ -77,7 +77,7 @@ public String getFailingSqlStatement() {
7777
return batchResult.getSql();
7878
}
7979

80-
/*
80+
/**
8181
* Returns the statement id of the statement that caused the failure
8282
*
8383
* @return the statement id

0 commit comments

Comments
 (0)