Skip to content

Commit d883e65

Browse files
committed
Javadoc
Remove redundant open paragraph HTML tag
1 parent e0834d9 commit d883e65

File tree

232 files changed

+1323
-1323
lines changed

Some content is hidden

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

232 files changed

+1323
-1323
lines changed

commons-jcs3-core/src/main/java/org/apache/commons/jcs3/JCS.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ else if ( configFileName != null )
8282

8383
/**
8484
* Gets a GroupCacheAccess which accesses the provided region.
85-
* <p>
85+
*
8686
* @param region Region that return GroupCacheAccess will provide access to
8787
* @return A GroupCacheAccess which provides access to a given region.
8888
* @throws CacheException
@@ -96,7 +96,7 @@ public static <K, V> GroupCacheAccess<K, V> getGroupCacheInstance( final String
9696

9797
/**
9898
* Gets a GroupCacheAccess which accesses the provided region.
99-
* <p>
99+
*
100100
* @param region Region that return GroupCacheAccess will provide access to
101101
* @param icca CacheAttributes for region
102102
* @return A GroupCacheAccess which provides access to a given region.
@@ -111,7 +111,7 @@ public static <K, V> GroupCacheAccess<K, V> getGroupCacheInstance( final String
111111

112112
/**
113113
* Gets a GroupCacheAccess which accesses the provided region.
114-
* <p>
114+
*
115115
* @param region Region that return CacheAccess will provide access to
116116
* @param icca CacheAttributes for region
117117
* @param eattr ElementAttributes for the region
@@ -127,7 +127,7 @@ public static <K, V> GroupCacheAccess<K, V> getGroupCacheInstance( final String
127127

128128
/**
129129
* Gets a CacheAccess which accesses the provided region.
130-
* <p>
130+
*
131131
* @param region Region that return CacheAccess will provide access to
132132
* @return A CacheAccess which provides access to a given region.
133133
* @throws CacheException
@@ -141,7 +141,7 @@ public static <K, V> CacheAccess<K, V> getInstance( final String region )
141141

142142
/**
143143
* Gets a CacheAccess which accesses the provided region.
144-
* <p>
144+
*
145145
* @param region Region that return CacheAccess will provide access to
146146
* @param icca CacheAttributes for region
147147
* @return A CacheAccess which provides access to a given region.
@@ -156,7 +156,7 @@ public static <K, V> CacheAccess<K, V> getInstance( final String region, final I
156156

157157
/**
158158
* Gets a CacheAccess which accesses the provided region.
159-
* <p>
159+
*
160160
* @param region Region that return CacheAccess will provide access to
161161
* @param icca CacheAttributes for region
162162
* @param eattr ElementAttributes for the region

commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/AbstractCacheAccess.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public abstract class AbstractCacheAccess<K, V>
5151

5252
/**
5353
* Constructor for the CacheAccess object.
54-
* <p>
54+
*
5555
* @param cacheControl The cache which the created instance accesses
5656
*/
5757
protected AbstractCacheAccess( final CompositeCache<K, V> cacheControl )
@@ -61,7 +61,7 @@ protected AbstractCacheAccess( final CompositeCache<K, V> cacheControl )
6161

6262
/**
6363
* Removes all of the elements from a region.
64-
* <p>
64+
*
6565
* @throws CacheException
6666
*/
6767
@Override
@@ -94,7 +94,7 @@ public void dispose()
9494
* This instructs the memory cache to remove the <em>numberToFree</em> according to its eviction
9595
* policy. For example, the LRUMemoryCache will remove the <em>numberToFree</em> least recently
9696
* used items. These will be spooled to disk if a disk auxiliary is available.
97-
* <p>
97+
*
9898
* @param numberToFree
9999
* @return the number that were removed. if you ask to free 5, but there are only 3, you will
100100
* get 3.
@@ -119,7 +119,7 @@ public int freeMemoryElements( final int numberToFree )
119119

120120
/**
121121
* Gets the ICompositeCacheAttributes of the cache region.
122-
* <p>
122+
*
123123
* @return ICompositeCacheAttributes, the controllers config info, defined in the top section of
124124
* a region definition.
125125
*/
@@ -139,7 +139,7 @@ public CompositeCache<K, V> getCacheControl() {
139139
* <p>
140140
* Each time an element is added to the cache without element attributes, the default element
141141
* attributes are cloned.
142-
* <p>
142+
*
143143
* @return the default element attributes used by this region.
144144
* @throws CacheException
145145
*/
@@ -154,7 +154,7 @@ public IElementAttributes getDefaultElementAttributes()
154154
* This returns the ICacheStats object with information on this region and its auxiliaries.
155155
* <p>
156156
* This data can be formatted as needed.
157-
* <p>
157+
*
158158
* @return ICacheStats
159159
*/
160160
@Override
@@ -174,7 +174,7 @@ public String getStats()
174174

175175
/**
176176
* Sets the ICompositeCacheAttributes of the cache region.
177-
* <p>
177+
*
178178
* @param cattr The new ICompositeCacheAttribute value
179179
*/
180180
@Override
@@ -189,7 +189,7 @@ public void setCacheAttributes( final ICompositeCacheAttributes cattr )
189189
* remote items. Rather than have unpredictable behavior, this method just sets the default
190190
* attributes. Items subsequently put into the cache will use these defaults if they do not
191191
* specify specific attributes.
192-
* <p>
192+
*
193193
* @param attr the default attributes.
194194
* @throws CacheException if something goes wrong.
195195
*/

commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/CacheAccess.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public class CacheAccess<K, V>
5454
{
5555
/**
5656
* Constructor for the CacheAccess object.
57-
* <p>
57+
*
5858
* @param cacheControl The cache which the created instance accesses
5959
*/
6060
public CacheAccess( final CompositeCache<K, V> cacheControl )
@@ -64,7 +64,7 @@ public CacheAccess( final CompositeCache<K, V> cacheControl )
6464

6565
/**
6666
* Retrieve an object from the cache region this instance provides access to.
67-
* <p>
67+
*
6868
* @param name Key the object is stored as
6969
* @return The object if found or null
7070
*/
@@ -80,7 +80,7 @@ public V get( final K name )
8080
* Retrieve an object from the cache region this instance provides access to.
8181
* If the object cannot be found in the cache, it will be retrieved by
8282
* calling the supplier and subsequently storing it in the cache.
83-
* <p>
83+
*
8484
* @param name
8585
* @param supplier supplier to be called if the value is not found
8686
* @return Object.
@@ -110,7 +110,7 @@ public V get(final K name, final Supplier<V> supplier)
110110
* has been in the cache.
111111
* <p>
112112
* The last access time in the ElementAttributes should be current.
113-
* <p>
113+
*
114114
* @param name Key the Serializable is stored as
115115
* @return The ICacheElement&lt;K, V&gt; if the object is found or null
116116
*/
@@ -133,7 +133,7 @@ public ICacheElement<K, V> getCacheElement( final K name )
133133
* has been in the cache.
134134
* <p>
135135
* The last access time in the ElementAttributes should be current.
136-
* <p>
136+
*
137137
* @param names set of Serializable cache keys
138138
* @return a map of K key to ICacheElement&lt;K, V&gt; element, or empty map if none of the keys are present
139139
*/
@@ -147,7 +147,7 @@ public Map<K, ICacheElement<K, V>> getCacheElements( final Set<K> names )
147147
* GetElementAttributes will return an attribute object describing the current attributes
148148
* associated with the object name. The name object must override the Object.equals and
149149
* Object.hashCode methods.
150-
* <p>
150+
*
151151
* @param name Key of object to get attributes for
152152
* @return Attributes for the object, null if object not in cache
153153
*/
@@ -170,7 +170,7 @@ public IElementAttributes getElementAttributes( final K name ) throws CacheExcep
170170

171171
/**
172172
* Retrieve matching objects from the cache region this instance provides access to.
173-
* <p>
173+
*
174174
* @param pattern a key pattern for the objects stored
175175
* @return A map of key to values. These are stripped from the wrapper.
176176
*/
@@ -211,7 +211,7 @@ public Map<K, V> getMatching( final String pattern )
211211
* has been in the cache.
212212
* <p>
213213
* The last access time in the ElementAttributes should be current.
214-
* <p>
214+
*
215215
* @param pattern key search pattern
216216
* @return a map of K key to ICacheElement&lt;K, V&gt; element, or empty map if no keys match the pattern
217217
*/
@@ -240,7 +240,7 @@ public void put( final K name, final V obj )
240240
* Constructs a cache element with these attributes, and puts it into the cache.
241241
* <p>
242242
* If the key or the value is null, and InvalidArgumentException is thrown.
243-
* <p>
243+
*
244244
* @see org.apache.commons.jcs3.access.behavior.ICacheAccess#put(Object, Object, IElementAttributes)
245245
*/
246246
@Override
@@ -277,7 +277,7 @@ public void put( final K key, final V val, final IElementAttributes attr )
277277
* Place a new object in the cache, associated with key name. If there is currently an object
278278
* associated with name in the region an ObjectExistsException is thrown. Names are scoped to a
279279
* region so they must be unique within the region they are placed.
280-
* <p>
280+
*
281281
* @param key Key object will be stored with
282282
* @param value Object to store
283283
* @throws CacheException and ObjectExistsException is thrown if the item is already in the
@@ -296,7 +296,7 @@ public void putSafe( final K key, final V value )
296296

297297
/**
298298
* Removes a single item by name.
299-
* <p>
299+
*
300300
* @param name the name of the item to remove.
301301
*/
302302
@Override
@@ -308,7 +308,7 @@ public void remove( final K name )
308308
/**
309309
* Reset attributes for a particular element in the cache. NOTE: this method is currently not
310310
* implemented.
311-
* <p>
311+
*
312312
* @param name Key of object to reset attributes for
313313
* @param attr New attributes for the object
314314
* @throws InvalidHandleException if the item does not exist.

commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/GroupCacheAccess.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public class GroupCacheAccess<K, V>
4242
{
4343
/**
4444
* Constructor for the GroupCacheAccess object
45-
* <p>
45+
*
4646
* @param cacheControl
4747
*/
4848
public GroupCacheAccess( final CompositeCache<GroupAttrName<K>, V> cacheControl )
@@ -52,7 +52,7 @@ public GroupCacheAccess( final CompositeCache<GroupAttrName<K>, V> cacheControl
5252

5353
/**
5454
* Gets an item out of the cache that is in a specified group.
55-
* <p>
55+
*
5656
* @param name
5757
* The key name.
5858
* @param group
@@ -68,7 +68,7 @@ public V getFromGroup( final K name, final String group )
6868

6969
/**
7070
* Internal method used for group functionality.
71-
* <p>
71+
*
7272
* @param group
7373
* @param name
7474
* @return GroupAttrName
@@ -81,7 +81,7 @@ private GroupAttrName<K> getGroupAttrName( final String group, final K name )
8181

8282
/**
8383
* Gets the set of keys of objects currently in the group.
84-
* <p>
84+
*
8585
* @param group
8686
* @return A Set of keys.
8787
*/
@@ -99,7 +99,7 @@ public Set<K> getGroupKeys( final String group )
9999

100100
/**
101101
* Gets the set of group names in the cache
102-
* <p>
102+
*
103103
* @return A Set of group names.
104104
*/
105105
public Set<String> getGroupNames()
@@ -112,7 +112,7 @@ public Set<String> getGroupNames()
112112

113113
/**
114114
* Invalidates a group: remove all the group members
115-
* <p>
115+
*
116116
* @param group
117117
* The name of the group to invalidate
118118
*/
@@ -126,7 +126,7 @@ public void invalidateGroup( final String group )
126126
* Allows the user to put an object into a group within a particular cache
127127
* region. This method sets the object's attributes to the default for the
128128
* region.
129-
* <p>
129+
*
130130
* @param name
131131
* The key name.
132132
* @param groupName
@@ -146,7 +146,7 @@ public void putInGroup( final K name, final String groupName, final V value )
146146
* Allows the user to put an object into a group within a particular cache
147147
* region. This method allows the object's attributes to be individually
148148
* specified.
149-
* <p>
149+
*
150150
* @param name
151151
* The key name.
152152
* @param groupName

0 commit comments

Comments
 (0)