Skip to content

Commit e8fa91e

Browse files
garydgregorygarydgregory
committed
Fix redundant Javadoc phrasing
1 parent 2d7b8ef commit e8fa91e

File tree

47 files changed

+113
-113
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+113
-113
lines changed

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCacheAttributes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public int getShutdownSpoolTimeLimit()
102102
}
103103

104104
/**
105-
* @return Returns the allowRemoveAll.
105+
* @return the allowRemoveAll.
106106
*/
107107
@Override
108108
public boolean isAllowRemoveAll()

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDisk.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ protected void freeBlocks(final int[] blocksToFree)
221221
}
222222

223223
/**
224-
* @return Returns the average size of the an element inserted.
224+
* @return the average size of the an element inserted.
225225
*/
226226
protected long getAveragePutSizeBytes()
227227
{
@@ -272,15 +272,15 @@ protected byte[][] getBlockChunks(final byte[] complete, final int numBlocksNeed
272272
}
273273

274274
/**
275-
* @return Returns the blockSizeBytes.
275+
* @return the blockSizeBytes.
276276
*/
277277
protected int getBlockSizeBytes()
278278
{
279279
return blockSizeBytes;
280280
}
281281

282282
/**
283-
* @return Returns the number of empty blocks.
283+
* @return the number of empty blocks.
284284
*/
285285
protected int getEmptyBlocks()
286286
{
@@ -298,7 +298,7 @@ protected String getFilePath()
298298
}
299299

300300
/**
301-
* @return Returns the numberOfBlocks.
301+
* @return the numberOfBlocks.
302302
*/
303303
protected int getNumberOfBlocks()
304304
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskCacheAttributes.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ public class BlockDiskCacheAttributes
4646
private long keyPersistenceIntervalSeconds = DEFAULT_KEY_PERSISTENCE_INTERVAL_SECONDS;
4747

4848
/**
49-
* @return Returns the blockSizeBytes.
49+
* @return the blockSizeBytes.
5050
*/
5151
public int getBlockSizeBytes()
5252
{
5353
return blockSizeBytes;
5454
}
5555

5656
/**
57-
* @return Returns the keyPersistenceIntervalSeconds.
57+
* @return the keyPersistenceIntervalSeconds.
5858
*/
5959
public long getKeyPersistenceIntervalSeconds()
6060
{
6161
return keyPersistenceIntervalSeconds;
6262
}
6363

6464
/**
65-
* @return Returns the maxKeySize.
65+
* @return the maxKeySize.
6666
*/
6767
public int getMaxKeySize()
6868
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskElementDescriptor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,15 @@ public BlockDiskElementDescriptor(final K key, final int[] blocks)
6666
/**
6767
* This holds the block numbers. An item my be dispersed between multiple blocks.
6868
* <p>
69-
* @return Returns the blocks.
69+
* @return the blocks.
7070
*/
7171
public int[] getBlocks()
7272
{
7373
return blocks;
7474
}
7575

7676
/**
77-
* @return Returns the key.
77+
* @return the key.
7878
*/
7979
public K getKey()
8080
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ public void dump(final boolean dumpValues)
722722
}
723723

724724
/**
725-
* @return Returns the AuxiliaryCacheAttributes.
725+
* @return the AuxiliaryCacheAttributes.
726726
*/
727727
@Override
728728
public AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
@@ -888,7 +888,7 @@ public synchronized IStats getStatistics()
888888
* This is exposed for testing.
889889
* <p>
890890
*
891-
* @return Returns the timesOptimized.
891+
* @return the timesOptimized.
892892
*/
893893
protected int getTimesOptimized()
894894
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCacheAttributes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public boolean isClearDiskOnStartup()
8787
}
8888

8989
/**
90-
* @return Returns the optimizeOnShutdown.
90+
* @return the optimizeOnShutdown.
9191
*/
9292
public boolean isOptimizeOnShutdown()
9393
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/JDBCDiskCache.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ protected boolean doesElementExist( final ICacheElement<K, V> ce, final JDBCConn
266266
}
267267

268268
/**
269-
* @return Returns the AuxiliaryCacheAttributes.
269+
* @return the AuxiliaryCacheAttributes.
270270
*/
271271
@Override
272272
public AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
@@ -296,7 +296,7 @@ protected String getDiskLocation()
296296
}
297297

298298
/**
299-
* @return Returns the jdbcDiskCacheAttributes.
299+
* @return the jdbcDiskCacheAttributes.
300300
*/
301301
protected JDBCDiskCacheAttributes getJdbcDiskCacheAttributes()
302302
{
@@ -394,7 +394,7 @@ protected String getTableName()
394394
}
395395

396396
/**
397-
* @return Returns the tableState.
397+
* @return the tableState.
398398
*/
399399
public TableState getTableState()
400400
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,15 @@ public String getConnectionPoolName()
101101
}
102102

103103
/**
104-
* @return Returns the database.
104+
* @return the database.
105105
*/
106106
public String getDatabase()
107107
{
108108
return database;
109109
}
110110

111111
/**
112-
* @return Returns the driverClassName.
112+
* @return the driverClassName.
113113
*/
114114
public String getDriverClassName()
115115
{
@@ -133,63 +133,63 @@ public long getJndiTTL()
133133
}
134134

135135
/**
136-
* @return Returns the maxTotal.
136+
* @return the maxTotal.
137137
*/
138138
public int getMaxTotal()
139139
{
140140
return maxTotal;
141141
}
142142

143143
/**
144-
* @return Returns the password.
144+
* @return the password.
145145
*/
146146
public String getPassword()
147147
{
148148
return password;
149149
}
150150

151151
/**
152-
* @return Returns the shrinkerIntervalSeconds.
152+
* @return the shrinkerIntervalSeconds.
153153
*/
154154
public int getShrinkerIntervalSeconds()
155155
{
156156
return shrinkerIntervalSeconds;
157157
}
158158

159159
/**
160-
* @return Returns the tableName.
160+
* @return the tableName.
161161
*/
162162
public String getTableName()
163163
{
164164
return tableName;
165165
}
166166

167167
/**
168-
* @return Returns the url.
168+
* @return the url.
169169
*/
170170
public String getUrl()
171171
{
172172
return url;
173173
}
174174

175175
/**
176-
* @return Returns the userName.
176+
* @return the userName.
177177
*/
178178
public String getUserName()
179179
{
180180
return userName;
181181
}
182182

183183
/**
184-
* @return Returns the testBeforeInsert.
184+
* @return the testBeforeInsert.
185185
*/
186186
public boolean isTestBeforeInsert()
187187
{
188188
return testBeforeInsert;
189189
}
190190

191191
/**
192-
* @return Returns the useDiskShrinker.
192+
* @return the useDiskShrinker.
193193
*/
194194
public boolean isUseDiskShrinker()
195195
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/ShrinkerThread.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ private void deleteExpiredFromAllRegisteredRegions()
110110
* How long should we wait between calls to deleteExpired when we are iterating through the list
111111
* of regions.
112112
* <p>
113-
* @return Returns the pauseBetweenRegionCallsMillis.
113+
* @return the pauseBetweenRegionCallsMillis.
114114
*/
115115
public long getPauseBetweenRegionCallsMillis()
116116
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/TableState.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ public TableState( final String tableName )
6262
}
6363

6464
/**
65-
* @return Returns the state.
65+
* @return the state.
6666
*/
6767
public int getState()
6868
{
6969
return state;
7070
}
7171

7272
/**
73-
* @return Returns the tableName.
73+
* @return the tableName.
7474
*/
7575
public String getTableName()
7676
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLDiskCacheAttributes.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public class MySQLDiskCacheAttributes
5454
private boolean balkDuringOptimization = DEFAULT_BALK_DURING_OPTIMIZATION;
5555

5656
/**
57-
* @return Returns the optimizationSchedule.
57+
* @return the optimizationSchedule.
5858
*/
5959
public String getOptimizationSchedule()
6060
{
@@ -64,7 +64,7 @@ public String getOptimizationSchedule()
6464
/**
6565
* Should we return null while optimizing the table.
6666
* <p>
67-
* @return Returns the balkDuringOptimization.
67+
* @return the balkDuringOptimization.
6868
*/
6969
public boolean isBalkDuringOptimization()
7070
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLTableOptimizer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public MySQLTableOptimizer( final MySQLDiskCacheAttributes attributes, final Tab
6969
}
7070

7171
/**
72-
* @return Returns the tableName.
72+
* @return the tableName.
7373
*/
7474
public String getTableName()
7575
{

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCache.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ public void fixCache( final ICacheServiceNonLocal<K, V> restoredLateral )
107107
}
108108

109109
/**
110-
* @return Returns the AuxiliaryCacheAttributes.
110+
* @return the AuxiliaryCacheAttributes.
111111
*/
112112
@Override
113113
public ILateralCacheAttributes getAuxiliaryCacheAttributes()

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheAttributes.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ public int getUdpMulticastPort()
138138
* The number of elements the zombie queue will hold. This queue is used to store events if we
139139
* loose our connection with the server.
140140
* <p>
141-
* @return Returns the zombieQueueMaxSize.
141+
* @return the zombieQueueMaxSize.
142142
*/
143143
@Override
144144
public int getZombieQueueMaxSize()
@@ -147,7 +147,7 @@ public int getZombieQueueMaxSize()
147147
}
148148

149149
/**
150-
* @return Returns the receive.
150+
* @return the receive.
151151
*/
152152
@Override
153153
public boolean isReceive()

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ public ICacheElement<K, V> get( final K key )
171171
}
172172

173173
/**
174-
* @return Returns the AuxiliaryCacheAttributes.
174+
* @return the AuxiliaryCacheAttributes.
175175
*/
176176
@Override
177177
public ILateralCacheAttributes getAuxiliaryCacheAttributes()

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWaitFacade.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ public ICacheElement<K, V> get( final K key )
175175
}
176176

177177
/**
178-
* @return Returns the AuxiliaryCacheAttributes.
178+
* @return the AuxiliaryCacheAttributes.
179179
*/
180180
@Override
181181
public ILateralCacheAttributes getAuxiliaryCacheAttributes()

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/behavior/ILateralCacheAttributes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public String toString()
118118
* The number of elements the zombie queue will hold. This queue is used to store events if we
119119
* loose our connection with the server.
120120
* <p>
121-
* @return Returns the zombieQueueMaxSize.
121+
* @return the zombieQueueMaxSize.
122122
*/
123123
int getZombieQueueMaxSize();
124124

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/behavior/ILateralCacheListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public interface ILateralCacheListener<K, V>
3434
void dispose();
3535

3636
/**
37-
* @return Returns the cacheMgr.
37+
* @return the cacheMgr.
3838
*/
3939
ICompositeCacheManager getCacheManager();
4040

‎commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPListener.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ protected CompositeCache<K, V> getCache( final String name )
160160
}
161161

162162
/**
163-
* @return Returns the cacheMgr.
163+
* @return the cacheMgr.
164164
*/
165165
@Override
166166
public ICompositeCacheManager getCacheManager()
@@ -169,7 +169,7 @@ public ICompositeCacheManager getCacheManager()
169169
}
170170

171171
/**
172-
* @return Returns the getCnt.
172+
* @return the getCnt.
173173
*/
174174
public int getGetCnt()
175175
{
@@ -192,23 +192,23 @@ public long getListenerId()
192192
/**
193193
* This is roughly the number of updates the lateral has received.
194194
* <p>
195-
* @return Returns the putCnt.
195+
* @return the putCnt.
196196
*/
197197
public int getPutCnt()
198198
{
199199
return putCnt;
200200
}
201201

202202
/**
203-
* @return Returns the removeCnt.
203+
* @return the removeCnt.
204204
*/
205205
public int getRemoveCnt()
206206
{
207207
return removeCnt;
208208
}
209209

210210
/**
211-
* @return Returns the tcpLateralCacheAttributes.
211+
* @return the tcpLateralCacheAttributes.
212212
*/
213213
public ITCPLateralCacheAttributes getTcpLateralCacheAttributes()
214214
{

0 commit comments

Comments
 (0)