Return-Path: Delivered-To: apmail-jakarta-jcs-dev-archive@www.apache.org Received: (qmail 30726 invoked from network); 23 Jun 2006 19:55:07 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 23 Jun 2006 19:55:07 -0000 Received: (qmail 65162 invoked by uid 500); 23 Jun 2006 19:55:07 -0000 Delivered-To: apmail-jakarta-jcs-dev-archive@jakarta.apache.org Received: (qmail 65137 invoked by uid 500); 23 Jun 2006 19:55:06 -0000 Mailing-List: contact jcs-dev-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "JCS Developers List" Delivered-To: mailing list jcs-dev@jakarta.apache.org Received: (qmail 65125 invoked by uid 500); 23 Jun 2006 19:55:06 -0000 Delivered-To: apmail-jakarta-jcs-commits@jakarta.apache.org Received: (qmail 65122 invoked by uid 500); 23 Jun 2006 19:55:06 -0000 Delivered-To: apmail-jakarta-jcs-cvs@jakarta.apache.org Received: (qmail 65119 invoked by uid 99); 23 Jun 2006 19:55:06 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 23 Jun 2006 12:55:06 -0700 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received-SPF: pass (asf.osuosl.org: local policy) Received: from [140.211.166.113] (HELO eris.apache.org) (140.211.166.113) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 23 Jun 2006 12:55:02 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 91F511A983A; Fri, 23 Jun 2006 12:54:42 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r416809 [1/3] - in /jakarta/jcs/trunk/src: java/org/apache/jcs/access/ java/org/apache/jcs/access/behavior/ java/org/apache/jcs/access/exception/ java/org/apache/jcs/access/monitor/ java/org/apache/jcs/admin/ java/org/apache/jcs/admin/servl... Date: Fri, 23 Jun 2006 19:54:28 -0000 To: jcs-cvs@jakarta.apache.org From: asmuts@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20060623195442.91F511A983A@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: asmuts Date: Fri Jun 23 12:54:25 2006 New Revision: 416809 URL: http://svn.apache.org/viewvc?rev=416809&view=rev Log: Improved a few javadocs. Formatting. Removing extra blank lines. Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/CacheAccess.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/GroupCacheAccess.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/ICacheAccess.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/IGroupCacheAccess.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/CacheException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidArgumentException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidGroupException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidHandleException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NotARetrievableObjectException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NullObjectException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectExistsException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectNotFoundException.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorAccess.java jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorXMLRPCServer.java jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheElementInfo.java jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheRegionInfo.java jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CountingOnlyOutputStream.java jakarta/jcs/trunk/src/java/org/apache/jcs/admin/JCSAdminBean.java jakarta/jcs/trunk/src/java/org/apache/jcs/admin/servlet/JCSAdminServlet.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCache.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCacheAttributes.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/LRUMapJCS.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/PurgatoryElement.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/behavior/IDiskCacheAttributes.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDisk.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDiskCache.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDiskCacheAttributes.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDiskCacheFactory.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDiskCacheManager.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDiskDumper.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/indexed/IndexedDiskElementDescriptor.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/jdbc/JDBCDiskCacheAttributes.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/jdbc/JDBCDiskCacheManager.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/jdbc/ShrinkerThread.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/jdbc/hsql/HSQLDiskCacheFactory.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheAttributes.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheListener.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheManager.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheObserver.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheService.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/socket/tcp/behavior/ITCPLateralCacheAttributes.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheService.java jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServer.java jakarta/jcs/trunk/src/test/org/apache/jcs/auxiliary/remote/RemoteCacheClientTester.java Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/CacheAccess.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/CacheAccess.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/CacheAccess.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/CacheAccess.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.access; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.io.IOException; @@ -23,6 +18,7 @@ import org.apache.commons.logging.LogFactory; import org.apache.jcs.access.behavior.ICacheAccess; import org.apache.jcs.access.exception.CacheException; +import org.apache.jcs.access.exception.InvalidArgumentException; import org.apache.jcs.access.exception.InvalidHandleException; import org.apache.jcs.access.exception.ObjectExistsException; import org.apache.jcs.engine.CacheElement; @@ -43,8 +39,6 @@ * configuration, put an item in the cache, remove an item, and clear a region. *

* The JCS class is the prefered way to access these methods. - * - * @version $Id$ */ public class CacheAccess implements ICacheAccess @@ -58,14 +52,14 @@ /** * The cache that a given instance of this class provides access to. - * + *

* @TODO Should this be the inteface? */ protected CompositeCache cacheControl; /** * Constructor for the CacheAccess object. - * + *

* @param cacheControl * The cache which the created instance accesses */ @@ -84,7 +78,7 @@ * cache in the props file and then strictly use the get access method. Use * of the define region outside of an initialization block should be * avoided. - * + *

* @param name * Name that will identify the region * @return CacheAccess instance for the new region @@ -100,7 +94,7 @@ /** * Define a new cache region with the specified name and attributes. - * + *

* @param name * Name that will identify the region * @param cattr @@ -119,7 +113,7 @@ /** * Define a new cache region with the specified name and attributes and * return a CacheAccess to it. - * + *

* @param name * Name that will identify the region * @param cattr @@ -139,7 +133,7 @@ /** * Get a CacheAccess instance for the given region. - * + *

* @param region * Name that identifies the region * @return CacheAccess instance for region @@ -156,7 +150,7 @@ /** * Get a CacheAccess instance for the given region with the given * attributes. - * + *

* @param region * Name that identifies the region * @param icca @@ -191,7 +185,7 @@ /** * Retrieve an object from the cache region this instance provides access * to. - * + *

* @param name * Key the object is stored as * @return The object if found or null @@ -214,7 +208,7 @@ * how long the element has been in the cache. *

* The last access time in teh ElementAttributes should be current. - * + *

* @param name * Key the object is stored as * @return The ICacheElement if the object is found or null @@ -229,12 +223,14 @@ * currently an object associated with name in the region an * ObjectExistsException is thrown. Names are scoped to a region so they * must be unique within the region they are placed. - * + *

* @param key * Key object will be stored with * @param value * Object to store * @exception CacheException + * and ObjectExistsException is thrown if the item is already + * in the cache. */ public void putSafe( Object key, Object value ) throws CacheException @@ -251,8 +247,7 @@ * Place a new object in the cache, associated with key name. If there is * currently an object associated with name in the region it is replaced. * Names are scoped to a region so they must be unique within the region - * they are placed. - * + * they are placed. ObjectExistsException * @param name * Key object will be stored with * @param obj @@ -267,9 +262,12 @@ put( name, obj, this.cacheControl.getElementAttributes() ); } - /* - * (non-Javadoc) - * + /** + * Constructs a cache element with these attribures, and puts it into the + * cache. + *

+ * If the key or the value is null, and InvalidArgumentException is thrown. + *

* @see org.apache.jcs.access.behavior.ICacheAccess#put(java.lang.Object, * java.lang.Object, org.apache.jcs.engine.behavior.IElementAttributes) */ @@ -278,11 +276,11 @@ { if ( key == null ) { - throw new CacheException( "Key must not be null" ); + throw new InvalidArgumentException( "Key must not be null" ); } else if ( val == null ) { - throw new CacheException( "Value must not be null" ); + throw new InvalidArgumentException( "Value must not be null" ); } // Create the element and update. This may throw an IOException which @@ -305,9 +303,8 @@ /** * Destory the region and all objects within it. After calling this method, * the Cache object can no longer be used as it will be closed. - * + *

* @exception CacheException - * * @deprecated */ public void destroy() @@ -325,9 +322,8 @@ /** * Removes all of the elements from a region. - * + *

* @deprecated use clear() - * * @throws CacheException */ public void remove() @@ -338,7 +334,7 @@ /** * Removes all of the elements from a region. - * + *

* @throws CacheException */ public void clear() @@ -357,11 +353,10 @@ /** * Invalidate all objects associated with key name, removing all references * to the objects from the cache. - * + *

* @param name * Key that specifies object to invalidate * @exception CacheException - * * @deprecated use remove */ public void destroy( Object name ) @@ -372,7 +367,7 @@ /** * Removes a single item by name. - * + *

* @param name, * the name of the item to remove. * @throws CacheException @@ -390,16 +385,16 @@ * groups and regions will not affect existing objects. Only object loaded * after the reset will use the new defaults. If no name argument is * provided, the reset is applied to the region. - * + *

* NOTE: this method is does not reset the attributes for items already in * the cache. It could potentially do this for items in memory, and maybe on * disk (which would be slow) but not remote items. Rather than have * unpredicatble behavior, this method just sets the default attributes. + *

* TODO is should be renamed "setDefaultElementAttributes" - * + *

* @deprecated As of release 1.3 * @see setDefaultElementAttributes - * * @param attr * New attributes for this region. * @exception CacheException @@ -418,8 +413,7 @@ * unpredicatble behavior, this method just sets the default attributes. * Items subsequently put into the cache will use these defaults if they do * not specify specific attributes. - * - * + *

* @param attr * the default attributes. * @throws CacheException @@ -434,7 +428,7 @@ /** * Reset attributes for a particular element in the cache. NOTE: this method * is currently not implemented. - * + *

* @param name * Key of object to reset attributes for * @param attr @@ -465,10 +459,9 @@ * current attributes associated with the object name. *

* This was confusing, so I created a new method with a clear name. - * + *

* @deprecated As of release 1.3 * @see getDefaultElementAttributes - * * @return Attributes for this region * @exception CacheException */ @@ -484,7 +477,7 @@ *

* Each time an element is added to the cache without element attributes, * the default element attributes are cloned. - * + *

* @return the deafualt element attributes used by this region. * @throws CacheException */ @@ -498,7 +491,7 @@ * GetElementAttributes will return an attribute object describing the * current attributes associated with the object name. The name object must * override the Object.equals and Object.hashCode methods. - * + *

* @param name * Key of object to get attributes for * @return Attributes for the object, null if object not in cache @@ -526,7 +519,7 @@ * its auxiliaries. *

* This data can be formatted as needed. - * + *

* @return ICacheStats */ public ICacheStats getStatistics() @@ -535,7 +528,6 @@ } /** - * * @return A String version of the stats. */ public String getStats() @@ -555,8 +547,8 @@ } /** - * Gets the ICompositeCacheAttributes of the cache region - * + * Gets the ICompositeCacheAttributes of the cache region. + *

* @return ICompositeCacheAttributes, the controllers config info, defined * in the top section of a region definition. */ @@ -567,7 +559,7 @@ /** * Sets the ICompositeCacheAttributes of the cache region. - * + *

* @param cattr * The new ICompositeCacheAttribute value */ @@ -575,5 +567,4 @@ { this.cacheControl.setCacheAttributes( cattr ); } - } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/GroupCacheAccess.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/GroupCacheAccess.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/GroupCacheAccess.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/GroupCacheAccess.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.access; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.util.Set; @@ -30,7 +25,6 @@ /** * Access for groups. - * */ public class GroupCacheAccess extends CacheAccess @@ -40,7 +34,7 @@ /** * Constructor for the GroupCacheAccess object - * + *

* @param cacheControl */ public GroupCacheAccess( CompositeCache cacheControl ) @@ -50,7 +44,7 @@ /** * Gets the groupAccess attribute of the GroupCacheAccess class. - * + *

* @param region * @return The groupAccess value * @throws CacheException @@ -70,7 +64,7 @@ /** * Gets the groupAccess attribute of the GroupCacheAccess class. - * + *

* @param region * @param icca * @return The groupAccess value @@ -92,7 +86,7 @@ /** * Gets an item out of the cache that is in a specified group. - * + *

* @param name * The key name. * @param group @@ -105,6 +99,13 @@ return ( element != null ) ? element.getVal() : null; } + /** + * Internal method used for group functionality. + *

+ * @param group + * @param name + * @return GroupAttrName + */ private GroupAttrName getGroupAttrName( String group, Object name ) { GroupId gid = new GroupId( this.cacheControl.getCacheName(), group ); @@ -115,7 +116,7 @@ * Allows the user to put an object into a group within a particular cache * region. This method sets the object's attributes to the default for the * region. - * + *

* @param name * The key name. * @param groupName @@ -134,7 +135,7 @@ * Allows the user to put an object into a group within a particular cache * region. This method allows the object's attributes to be individually * specified. - * + *

* @param name * The key name. * @param groupName @@ -164,7 +165,6 @@ /** * @param name * @param group - * */ public void remove( Object name, String group ) { @@ -174,7 +174,7 @@ /** * Gets the set of keys of objects currently in the group. - * + *

* @param group * @return A Set of keys. */ @@ -185,7 +185,7 @@ /** * Invalidates a group: remove all the group members - * + *

* @param group * The name of the group to invalidate */ Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/ICacheAccess.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/ICacheAccess.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/ICacheAccess.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/ICacheAccess.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.access.behavior; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import org.apache.jcs.access.exception.CacheException; @@ -21,23 +16,13 @@ import org.apache.jcs.engine.behavior.IElementAttributes; /** - * Description of the Interface - * + * ICacheAccess defines the behavior for client access. */ public interface ICacheAccess { - - // Static methods that should be implemented - //public static void defineRegion( String name, CacheAttributes cattr, - // Attributes attr ) throws CacheException; - //public static void defineRegion( String name, CacheAttributes cattr ) - // throws CacheException; - //public static void defineRegion( String name ) throws CacheException; - //public static CacheAccess getAccess( String region ); - /** * Basic get method. - * + *

* @param name * @return Object or null if not found. */ @@ -45,7 +30,7 @@ /** * Puts in cache if an item does not exist with the name in that region. - * + *

* @param name * @param obj * @throws CacheException @@ -55,7 +40,7 @@ /** * Puts and/or overides an element with the name in that region. - * + *

* @param name * @param obj * @throws CacheException @@ -65,7 +50,7 @@ /** * Description of the Method - * + *

* @param name * @param obj * @param attr @@ -76,9 +61,8 @@ /** * Removes an item or all items. Should be called remove. - * + *

* @throws CacheException - * * @deprecated * @see #remove */ @@ -87,7 +71,6 @@ /** * Old remove all method. - * * @throws CacheException */ void remove() @@ -95,10 +78,9 @@ /** * The older removeall method. - * + *

* @param name * @throws CacheException - * * @deprecated * @see #remove */ @@ -107,7 +89,7 @@ /** * Remove an object for this key if one exists, else do nothing. - * + *

* @param name * @throws CacheException */ @@ -123,7 +105,7 @@ * default settings on groups and regions will not affect existing objects. * Only object loaded after the reset will use the new defaults. If no name * argument is provided, the reset is applied to the region. - * + *

* @param attr * @throws CacheException */ @@ -132,7 +114,7 @@ /** * Reset the attributes on the object matching this key name. - * + *

* @param name * @param attr * @throws CacheException @@ -145,7 +127,7 @@ * current attributes associated with the object name. If no name parameter * is available, the attributes for the region will be returned. The name * object must override the Object.equals and Object.hashCode methods. - * + *

* @return The elementAttributes value * @throws CacheException */ @@ -154,9 +136,8 @@ /** * Gets the elementAttributes attribute of the ICacheAccess object - * + *

* @param name - * * @return The elementAttributes value * @throws CacheException */ @@ -165,14 +146,14 @@ /** * Gets the ICompositeCacheAttributes of the cache region - * - * @return + *

+ * @return ICompositeCacheAttributes */ public ICompositeCacheAttributes getCacheAttributes(); /** * Sets the ICompositeCacheAttributes of the cache region - * + *

* @param cattr * The new ICompositeCacheAttribute value */ Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/IGroupCacheAccess.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/IGroupCacheAccess.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/IGroupCacheAccess.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/behavior/IGroupCacheAccess.java Fri Jun 23 12:54:25 2006 @@ -1,37 +1,31 @@ package org.apache.jcs.access.behavior; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.util.Set; import org.apache.jcs.access.exception.CacheException; - import org.apache.jcs.engine.behavior.IElementAttributes; /** - * Description of the Interface - * + * IGroupCacheAccess defines group specific behavior for the client access + * classes. */ public interface IGroupCacheAccess extends ICacheAccess { /** * Gets the g attribute of the IGroupCacheAccess object - * + *

* @param name * @param group * the name of the group to associate this with. @@ -41,7 +35,7 @@ /** * Puts an item int eh cache associated with this group. - * + *

* @param key * @param group * @param obj @@ -52,7 +46,7 @@ /** * Put in the cache associated with this group using these attributes. - * + *

* @param key * @param group * @param obj @@ -64,7 +58,7 @@ /** * Remove the item from this group in this region by this name. - * + *

* @param name * @param group */ @@ -72,7 +66,7 @@ /** * Gets the set of keys of objects currently in the group - * + *

* @param group * @return the set of group keys. */ @@ -80,7 +74,7 @@ /** * Invalidates a group - * + *

* @param group */ public void invalidateGroup( String group ); Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/CacheException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/CacheException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/CacheException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/CacheException.java Fri Jun 23 12:54:25 2006 @@ -1,27 +1,20 @@ package org.apache.jcs.access.exception; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ -//import org.apache.commons.lang.exception.NestableException; /** * This is the most general exception the cache throws. - * + *

* TODO make nested with no external dependencies. - * */ public class CacheException extends Exception @@ -40,7 +33,7 @@ /** * Constructor for the CacheException object - * + *

* @param nested */ public CacheException( Throwable nested ) @@ -50,7 +43,7 @@ /** * Constructor for the CacheException object - * + *

* @param message */ public CacheException( String message ) Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidArgumentException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidArgumentException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidArgumentException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidArgumentException.java Fri Jun 23 12:54:25 2006 @@ -1,29 +1,23 @@ package org.apache.jcs.access.exception; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ /** - * Description of the Class - * + * InvalidArgumentException is thrown if an argument is passed to the cache that + * is invalid. For instance, null values passed to put result in this exception. */ public class InvalidArgumentException extends CacheException { - private static final long serialVersionUID = -6058373692208755562L; /** Constructor for the InvalidArgumentException object */ @@ -34,12 +28,10 @@ /** * Constructor for the InvalidArgumentException object - * * @param message */ public InvalidArgumentException( String message ) { super( message ); } - } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidGroupException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidGroupException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidGroupException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidGroupException.java Fri Jun 23 12:54:25 2006 @@ -17,13 +17,12 @@ */ /** - * Description of the Class + * InvalidGroupException * */ public class InvalidGroupException extends CacheException { - private static final long serialVersionUID = -5219807114008843480L; /** Constructor for the InvalidGroupException object */ Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidHandleException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidHandleException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidHandleException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/InvalidHandleException.java Fri Jun 23 12:54:25 2006 @@ -1,24 +1,18 @@ package org.apache.jcs.access.exception; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ /** - * Description of the Class - * + * InvalidHandleException is not used. */ public class InvalidHandleException extends CacheException @@ -35,7 +29,6 @@ /** * Constructor for the InvalidHandleException object - * * @param message */ public InvalidHandleException( String message ) Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NotARetrievableObjectException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NotARetrievableObjectException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NotARetrievableObjectException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NotARetrievableObjectException.java Fri Jun 23 12:54:25 2006 @@ -17,8 +17,10 @@ */ /** - * Description of the Class - * + * This would be thrown if the object could not be retrieved from a method that + * throws exceptions rather than null. + *

+ * TODO check to see if we can get rid of this. */ public class NotARetrievableObjectException extends CacheException Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NullObjectException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NullObjectException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NullObjectException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/NullObjectException.java Fri Jun 23 12:54:25 2006 @@ -23,7 +23,6 @@ public class NullObjectException extends CacheException { - private static final long serialVersionUID = 827922769279844194L; /** Constructor for the NullObjectException object */ @@ -41,5 +40,4 @@ { super( message ); } - } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectExistsException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectExistsException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectExistsException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectExistsException.java Fri Jun 23 12:54:25 2006 @@ -1,28 +1,26 @@ package org.apache.jcs.access.exception; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ /** - * I'm removing this exception from use. The overhead of throwing exceptions and - * the cumbersomeness of coding around exceptions warrants removal. Exceptions - * like this don't make sense to throw in the course of normal operations to - * signify a normal and expected condition. Returning null if an object isn't - * found is sufficient. - * + * The putSafe method on the JCS convenience class throws this exception if the + * object is already present in the cache. + *

+ * I'm removing this exception from normal use. + *

+ * The overhead of throwing exceptions and the cumbersomeness of coding around + * exceptions warrants removal. Exceptions like this don't make sense to throw + * in the course of normal operations to signify a normal and expected + * condition. Returning null if an object isn't found is sufficient. */ public class ObjectExistsException extends CacheException @@ -38,7 +36,6 @@ /** * Constructor for the ObjectExistsException object - * * @param message */ public ObjectExistsException( String message ) Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectNotFoundException.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectNotFoundException.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectNotFoundException.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/exception/ObjectNotFoundException.java Fri Jun 23 12:54:25 2006 @@ -1,24 +1,23 @@ package org.apache.jcs.access.exception; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ /** - * Description of the Class - * + * ObjectNotFoundException + *

+ * TODO see if we can remove this. + *

+ * This is thrown from the composite cache if you as for the element attributes + * and the element does not exist. */ public class ObjectNotFoundException extends CacheException @@ -34,7 +33,6 @@ /** * Constructor for the ObjectNotFoundException object - * * @param message */ public ObjectNotFoundException( String message ) Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorAccess.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorAccess.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorAccess.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorAccess.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.access.monitor; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.io.Serializable; @@ -25,18 +20,16 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.jcs.access.GroupCacheAccess; +import org.apache.jcs.engine.CacheConstants; import org.apache.jcs.engine.behavior.ICache; import org.apache.jcs.engine.control.CompositeCacheManager; -import org.apache.jcs.engine.CacheConstants; /** * Exposes the simple monitoring methods to the public in a simple manner. - * */ public class MonitorAccess implements Serializable { - private static final long serialVersionUID = 1002037665133774391L; private static final Log log = LogFactory.getLog( MonitorAccess.class ); @@ -58,20 +51,18 @@ /** * Removes all. - * + *

* @param cacheName * @param key - * @return + * @return an informative message about what was deleted. */ public String delete( String cacheName, String key ) { - // some junk to return for a synchronous call String result = ""; try { - ICache cache = this.cacheMgr.getCache( cacheName ); if ( key != null ) @@ -123,12 +114,11 @@ /** * Gives basic info on all the regions. Better to use getStats. - * + *

* @return list of hashtables with keys (name,size,stat) */ public ArrayList overview() { - ArrayList data = new ArrayList(); String[] list = this.cacheMgr.getCacheNames(); @@ -157,5 +147,4 @@ } return data; } - } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorXMLRPCServer.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorXMLRPCServer.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorXMLRPCServer.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/access/monitor/MonitorXMLRPCServer.java Fri Jun 23 12:54:25 2006 @@ -1,29 +1,23 @@ package org.apache.jcs.access.monitor; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ -import org.apache.xmlrpc.WebServer; - import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import org.apache.xmlrpc.WebServer; /** * Starts an XML-RPC server for cache monitoring. - * + *

* @since 1.0 */ public class MonitorXMLRPCServer @@ -32,7 +26,6 @@ /** * Constructor for the MonitorXMLRPCServer object - * * @param port */ public MonitorXMLRPCServer( int port ) @@ -49,5 +42,4 @@ log.error( ioe ); } } - } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheElementInfo.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheElementInfo.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheElementInfo.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheElementInfo.java Fri Jun 23 12:54:25 2006 @@ -1,22 +1,19 @@ package org.apache.jcs.admin; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ -/** Stores info on a cache element for the template */ +/** + * Stores info on a cache element for the template + */ public class CacheElementInfo { String key = null; @@ -55,7 +52,6 @@ /** * Ignored if isEternal - * * @return the longest this object can live. */ public long getMaxLifeSeconds() @@ -65,7 +61,6 @@ /** * Ignored if isEternal - * * @return how many seconds until this object expires. */ public long getExpiresInSeconds() @@ -75,7 +70,6 @@ /* * (non-Javadoc) - * * @see java.lang.Object#toString() */ public String toString() Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheRegionInfo.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheRegionInfo.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheRegionInfo.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CacheRegionInfo.java Fri Jun 23 12:54:25 2006 @@ -1,25 +1,22 @@ package org.apache.jcs.admin; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import org.apache.jcs.engine.CacheConstants; import org.apache.jcs.engine.control.CompositeCache; -/** Stores info on a cache region for the template */ +/** + * Stores info on a cache region for the template + */ public class CacheRegionInfo { CompositeCache cache = null; @@ -60,7 +57,6 @@ /** * Return the stats for the region. - * * @return String */ public String getStats() @@ -70,7 +66,6 @@ /* * (non-Javadoc) - * * @see java.lang.Object#toString() */ public String toString() Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CountingOnlyOutputStream.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CountingOnlyOutputStream.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CountingOnlyOutputStream.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/admin/CountingOnlyOutputStream.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.admin; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.io.IOException; @@ -48,8 +43,8 @@ /** * The number of bytes that have passed through this stream. - * - * @return + *

+ * @return int */ public int getCount() { Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/admin/JCSAdminBean.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/admin/JCSAdminBean.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/admin/JCSAdminBean.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/admin/JCSAdminBean.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.admin; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.io.IOException; @@ -40,18 +35,15 @@ * provides the ability to remove items (any number of key arguments can be * provided with action 'remove'). Should be initialized with a properties file * that provides at least a classpath resource loader. - * */ public class JCSAdminBean { - private static final Log log = LogFactory.getLog( JCSAdminBean.class ); private CompositeCacheManager cacheHub = CompositeCacheManager.getInstance(); /** - * Builds up info about each element in a region. - * + * Builds up info about each element in a region. int * @param cacheName * @return List of CacheElementInfo objects * @throws Exception @@ -109,11 +101,9 @@ } /** - * Builds up data on every region. - * + * Builds up data on every region. int * @TODO we need a most light weight method that does not count bytes. The * byte counting can really swamp a server. - * * @return list of CacheRegionInfo objects * @throws Exception */ @@ -147,8 +137,7 @@ /** * Tries to estimate how much data is in a region. This is expensive. If * there are any non serializable objects in the region, the count will stop - * when it encouters the first one. - * + * when it encouters the first one. int * @param cache * @return * @throws Exception @@ -185,8 +174,7 @@ } /** - * Clears all regions in the cache. - * + * Clears all regions in the cache. int * @throws IOException */ public void clearAllRegions() @@ -201,8 +189,7 @@ } /** - * Clears a particular cache region. - * + * Clears a particular cache region. int * @param cacheName * @throws IOException */ @@ -213,8 +200,7 @@ } /** - * Removes a particular item from a particular region. - * + * Removes a particular item from a particular region. int * @param cacheName * @param key * @throws IOException Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/admin/servlet/JCSAdminServlet.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/admin/servlet/JCSAdminServlet.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/admin/servlet/JCSAdminServlet.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/admin/servlet/JCSAdminServlet.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.admin.servlet; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import javax.servlet.http.HttpServletRequest; @@ -32,32 +27,32 @@ * that provides at least a classpath resource loader. Since this extends * VelocityServlet, which uses the singleton model for velocity, it will share * configuration with any other Velocity in the same JVM. - * + *

* Initialization in a webapp will look something like this: + *

* * 

- * 
- *   [servlet]
- *       [servlet-name]JCSAdminServlet[/servlet-name]
- *       [servlet-class]org.apache.jcs.admin.servlet.JCSAdminServlet[/servlet-class]
- *       [init-param]
- *           [param-name]properties[/param-name]
- *           [param-value]WEB-INF/conf/JCSAdminServlet.velocity.properties[/param-value]
- *       [/init-param]
- *   [/servlet]
  *  
+ *    [servlet]
+ *        [servlet-name]JCSAdminServlet[/servlet-name]
+ *        [servlet-class]org.apache.jcs.admin.servlet.JCSAdminServlet[/servlet-class]
+ *        [init-param]
+ *            [param-name]properties[/param-name]
+ *            [param-value]WEB-INF/conf/JCSAdminServlet.velocity.properties[/param-value]
+ *        [/init-param]
+ *    [/servlet]
+ *   
  *
* + *

* FIXME: It would be nice to use the VelocityEngine model so this can be truly * standalone. Right now if you run it in the same container as, say, turbine, * turbine must be run first to ensure it's config takes precedence. - * - * @version $Id$ + *

*/ public class JCSAdminServlet extends VelocityServlet { - private static final long serialVersionUID = -5519844149238645275L; private static final String DEFAULT_TEMPLATE_NAME = "/org/apache/jcs/admin/servlet/JCSAdminServletDefault.vm"; @@ -85,13 +80,14 @@ private static final String DETAIL_ACTION = "detail"; /* - * (non-Javadoc) - * @see org.apache.velocity.servlet.VelocityServlet#handleRequest(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.apache.velocity.context.Context) + * (non-Javadoc) + * @see org.apache.velocity.servlet.VelocityServlet#handleRequest(javax.servlet.http.HttpServletRequest, + * javax.servlet.http.HttpServletResponse, + * org.apache.velocity.context.Context) */ protected Template handleRequest( HttpServletRequest request, HttpServletResponse response, Context context ) throws Exception { - JCSAdminBean admin = new JCSAdminBean(); String templateName = DEFAULT_TEMPLATE_NAME; @@ -154,5 +150,4 @@ return getTemplate( templateName ); } - } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCache.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCache.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCache.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCache.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.auxiliary.disk; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.io.IOException; @@ -47,17 +42,15 @@ * Abstract class providing a base implementation of a disk cache, which can be * easily extended to implement a disk cache for a specific perstistence * mechanism. - * + *

* When implementing the abstract methods note that while this base class * handles most things, it does not acquire or release any locks. * Implementations should do so as neccesary. This is mainly done to minimize * the time speant in critical sections. - * + *

* Error handling in this class needs to be addressed. Currently if an exception * is thrown by the persistence mechanism, this class destroys the event queue. * Should it also destory purgatory? Should it dispose itself? - * - * @version $Id$ */ public abstract class AbstractDiskCache implements AuxiliaryCache, Serializable @@ -71,9 +64,10 @@ * Map where elements are stored between being added to this cache and * actually spooled to disk. This allows puts to the disk cache to return * quickly, and the more expensive operation of serializing the elements to - * persistent storage queued for later. If the elements are pulled into the - * memory cache while the are still in purgatory, writing to disk can be - * cancelled. + * persistent storage queued for later. + *

+ * If the elements are pulled into the memory cache while the are still in + * purgatory, writing to disk can be cancelled. */ protected Map purgatory = new HashMap(); @@ -108,7 +102,7 @@ /** * Construc the abstract disk cache, create event queues and purgatory. - * + *

* @param attr */ public AbstractDiskCache( IDiskCacheAttributes attr ) @@ -130,13 +124,11 @@ /** * Purgatory size of -1 means to use a HashMap with no size limit. Anything * greater will use an LRU map of some sort. - * + *

* @TODO Currently setting this to 0 will cause nothing to be put to disk, * since it will assume that if an item is not in purgatory, then it * must have been plucked. We should make 0 work, a way to not use * purgatory. - * - * */ private void initPurgatory() { @@ -192,10 +184,9 @@ * An update results in a put event being created. The put event will call * the handlePut method defined here. The handlePut method calls the * implemented doPut on the child. - * + *

* @param cacheElement * @throws IOException - * * @see org.apache.jcs.engine.behavior.ICache#update */ public final void update( ICacheElement cacheElement ) @@ -236,10 +227,9 @@ /** * Check to see if the item is in purgatory. If so, return it. If not, check * to see if we have it on disk. - * + *

* @param key * @return ICacheElement or null - * * @see AuxiliaryCache#get */ public final ICacheElement get( Serializable key ) @@ -311,10 +301,9 @@ /** * Removes are not queued. A call to remove is immediate. - * + *

* @param key * @return whether the item was present to be removed. - * * @see org.apache.jcs.engine.behavior.ICache#remove */ public final boolean remove( Serializable key ) @@ -380,19 +369,17 @@ * Adds a dispose request to the disk cache. *

* Disposal proceeds in several steps. - *

    - *
  • 1. Prior to this call the Composite cache dumped the memory into the + *
      + *
    1. Prior to this call the Composite cache dumped the memory into the * disk cache. If it is large then we need to wait for the event queue to * finish. - *
    2. 2. Wait until the event queue is empty of until the configured + *
    3. Wait until the event queue is empty of until the configured * ShutdownSpoolTimeLimit is reached. - *
    4. 3. Call doDispose on the concrete impl. - *
- * + *
  • Call doDispose on the concrete impl. + * */ public final void dispose() { - Runnable disR = new Runnable() { public void run() @@ -438,7 +425,6 @@ doDispose(); alive = false; - } /** @@ -451,7 +437,7 @@ /** * Gets basic stats for the abstract disk cache. - * + *

    * @return String */ public String getStats() @@ -461,7 +447,6 @@ /* * (non-Javadoc) - * * @see org.apache.jcs.auxiliary.AuxiliaryCache#getStatistics() */ public IStats getStatistics() @@ -508,14 +493,13 @@ /** * Size cannot be determined without knowledge of the cache implementation, * so subclasses will need to implement this method. - * + *

    * @see ICache#getSize */ public abstract int getSize(); /** * @see org.apache.jcs.engine.behavior.ICacheType#getCacheType - * * @return Always returns DISK_CACHE since subclasses should all be of that * type. */ @@ -545,7 +529,6 @@ /** * @param id * @throws IOException - * * @see ICacheListener#setListenerId */ public void setListenerId( long id ) @@ -557,12 +540,11 @@ /** * @param element * @throws IOException - * @see ICacheListener#handlePut - * - * NOTE: This checks if the element is a puratory element and behaves - * differently depending. However since we have control over how - * elements are added to the cache event queue, that may not be needed ( - * they are always PurgatoryElements ). + * @see ICacheListener#handlePut NOTE: This checks if the element is a + * puratory element and behaves differently depending. However + * since we have control over how elements are added to the cache + * event queue, that may not be needed ( they are always + * PurgatoryElements ). */ public void handlePut( ICacheElement element ) throws IOException @@ -633,15 +615,13 @@ } else { - // The cache is not alive, hence the element should be removed - // from - // purgatory. All elements should be removed eventually. - // Perhaps, the alive check should have been done before it went - // in the - // queue. This block handles the case where the disk cache fails - // during normal opertations. - - // String keyAsString = element.getKey().toString(); + /* + * The cache is not alive, hence the element should be removed + * from purgatory. All elements should be removed eventually. + * Perhaps, the alive check should have been done before it went + * in the queue. This block handles the case where the disk + * cache fails during normal opertations. + */ synchronized ( purgatory ) { purgatory.remove( element.getKey() ); @@ -653,7 +633,6 @@ * @param cacheName * @param key * @throws IOException - * * @see ICacheListener#handleRemove */ public void handleRemove( String cacheName, Serializable key ) @@ -671,7 +650,6 @@ /** * @param cacheName * @throws IOException - * * @see ICacheListener#handleRemoveAll */ public void handleRemoveAll( String cacheName ) @@ -686,7 +664,6 @@ /** * @param cacheName * @throws IOException - * * @see ICacheListener#handleDispose */ public void handleDispose( String cacheName ) @@ -703,7 +680,6 @@ /** * Get a value from the persistent store. - * * @param key * Key to locate value for. * @return An object matching key, or null. @@ -712,14 +688,12 @@ /** * Add a cache element to the persistent store. - * * @param element */ protected abstract void doUpdate( ICacheElement element ); /** * Remove an object from the persistent store if found. - * * @param key * Key of object to remove. * @return whether or no the item was present when removed Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCacheAttributes.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCacheAttributes.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCacheAttributes.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/AbstractDiskCacheAttributes.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.auxiliary.disk; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") you may not - * use this file except in compliance with the License. You may obtain a copy of - * the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - * License for the specific language governing permissions and limitations under - * the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import org.apache.jcs.auxiliary.AbstractAuxiliaryCacheAttributes; @@ -22,9 +17,8 @@ /** * This has common attributes that any conceivable disk cache would need. - * + *

    * @author aaronsm - * */ public abstract class AbstractDiskCacheAttributes extends AbstractAuxiliaryCacheAttributes @@ -36,22 +30,20 @@ // if this is false, we will not execute remove all private boolean allowRemoveAll = true; - + /** default to 5000 */ protected int maxPurgatorySize = MAX_PURGATORY_SIZE_DEFUALT; private static final int DEFAULT_shutdownSpoolTimeLimit = 60; - + /** - * This default determines how long the shutdown will wait - * for the key spool and data defrag to finish. + * This default determines how long the shutdown will wait for the key spool + * and data defrag to finish. */ protected int shutdownSpoolTimeLimit = DEFAULT_shutdownSpoolTimeLimit; - - + /* * (non-Javadoc) - * * @see org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes#setDiskPath(java.lang.String) */ public void setDiskPath( String path ) @@ -61,7 +53,6 @@ /* * (non-Javadoc) - * * @see org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes#getDiskPath() */ public String getDiskPath() @@ -71,7 +62,6 @@ /* * (non-Javadoc) - * * @see org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes#getMaxPurgatorySize() */ public int getMaxPurgatorySize() @@ -81,7 +71,6 @@ /* * (non-Javadoc) - * * @see org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes#setMaxPurgatorySize(int) */ public void setMaxPurgatorySize( int maxPurgatorySize ) @@ -89,7 +78,8 @@ this.maxPurgatorySize = maxPurgatorySize; } - /* (non-Javadoc) + /* + * (non-Javadoc) * @see org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes#getShutdownSpoolTimeLimit() */ public int getShutdownSpoolTimeLimit() @@ -97,17 +87,17 @@ return this.shutdownSpoolTimeLimit; } - /* (non-Javadoc) + /* + * (non-Javadoc) * @see org.apache.jcs.auxiliary.disk.behavior.IDiskCacheAttributes#setShutdownSpoolTimeLimit(int) */ public void setShutdownSpoolTimeLimit( int shutdownSpoolTimeLimit ) { this.shutdownSpoolTimeLimit = shutdownSpoolTimeLimit; - } - + } + /** * Description of the Method - * * @return AuxiliaryCacheAttributes */ public AuxiliaryCacheAttributes copy() @@ -124,7 +114,8 @@ } /** - * @param allowRemoveAll The allowRemoveAll to set. + * @param allowRemoveAll + * The allowRemoveAll to set. */ public void setAllowRemoveAll( boolean allowRemoveAll ) { @@ -138,10 +129,10 @@ { return allowRemoveAll; } - + /** - * Description of the Method - * + * Includes the common attributes for a debug message. + *

    * @return String */ public String toString() Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/LRUMapJCS.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/LRUMapJCS.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/LRUMapJCS.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/LRUMapJCS.java Fri Jun 23 12:54:25 2006 @@ -1,6 +1,5 @@ package org.apache.jcs.auxiliary.disk; -//import org.apache.commons.collections.map.LRUMap; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.jcs.utils.struct.LRUMap; @@ -12,7 +11,6 @@ public class LRUMapJCS extends LRUMap { - private static final long serialVersionUID = 776964015449842672L; private static final Log log = LogFactory.getLog( LRUMapJCS.class ); @@ -33,7 +31,7 @@ * boundary is requested. *

    * The LRU memory cache uses its own LRU implementation. - * + *

    * @param maxKeySize */ public LRUMapJCS( int maxKeySize ) @@ -44,7 +42,7 @@ /** * This is called when an item is removed from the LRU. We just log some * information. - * + *

    * @param key * @param value */ @@ -52,8 +50,8 @@ { if ( log.isDebugEnabled() ) { - log.debug( "Removing key: [" + key + "] from key store, value = [" + value + "]" ); - log.debug( "Key store size: '" + this.size() + "'." ); + log.debug( "Removing key [" + key + "] from key store, value [" + value + "]" ); + log.debug( "Key store size [" + this.size() + "]" ); } } Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/PurgatoryElement.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/PurgatoryElement.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/PurgatoryElement.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/PurgatoryElement.java Fri Jun 23 12:54:25 2006 @@ -1,19 +1,14 @@ package org.apache.jcs.auxiliary.disk; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import java.io.Serializable; @@ -25,8 +20,6 @@ * Wrapper for cache elements in purgatory. Elements are stored in purgatory * when they are spooled to the auxilliary cache, but have not yet been written * to disk. - * - * @version $Id$ */ public class PurgatoryElement implements ICacheElement, Serializable @@ -45,7 +38,7 @@ /** * Constructor for the PurgatoryElement object - * + *

    * @param cacheElement * CacheElement to wrap. */ @@ -56,7 +49,7 @@ /** * Gets the spoolable property. - * + *

    * @return The spoolable value */ public boolean isSpoolable() @@ -66,7 +59,7 @@ /** * Sets the spoolable property. - * + *

    * @param spoolable * The new spoolable value */ @@ -77,7 +70,7 @@ /** * Get the wrapped cache element. - * + *

    * @return ICacheElement */ public ICacheElement getCacheElement() @@ -121,7 +114,6 @@ /** * @param attr - * * @see ICacheElement#setElementAttributes */ public void setElementAttributes( IElementAttributes attr ) Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/behavior/IDiskCacheAttributes.java URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/behavior/IDiskCacheAttributes.java?rev=416809&r1=416808&r2=416809&view=diff ============================================================================== --- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/behavior/IDiskCacheAttributes.java (original) +++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/disk/behavior/IDiskCacheAttributes.java Fri Jun 23 12:54:25 2006 @@ -1,63 +1,57 @@ package org.apache.jcs.auxiliary.disk.behavior; /* - * Copyright 2001-2004 The Apache Software Foundation. - * - * Licensed under the Apache License, Version 2.0 (the "License") - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Copyright 2001-2004 The Apache Software Foundation. Licensed under the Apache + * License, Version 2.0 (the "License") you may not use this file except in + * compliance with the License. You may obtain a copy of the License at + * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law + * or agreed to in writing, software distributed under the License is + * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the specific language + * governing permissions and limitations under the License. */ import org.apache.jcs.auxiliary.AuxiliaryCacheAttributes; /** * Common disk cache attributes. - * */ public interface IDiskCacheAttributes extends AuxiliaryCacheAttributes { /** - * This is the default purgatory size limit. Purgatory is the area - * where items to be spooled are temporarily stored. It basically provides - * access to items on the to-be-spooled queue. + * This is the default purgatory size limit. Purgatory is the area where + * items to be spooled are temporarily stored. It basically provides access + * to items on the to-be-spooled queue. */ public static final int MAX_PURGATORY_SIZE_DEFUALT = 5000; /** * Sets the diskPath attribute of the IJISPCacheAttributes object - * + *

    * @param path * The new diskPath value */ public void setDiskPath( String path ); /** - * Gets the diskPath attribute of the IJISPCacheAttributes object - * + * Gets the diskPath attribute of the attributes object + *

    * @return The diskPath value */ public String getDiskPath(); /** * Gets the maxKeySize attribute of the DiskCacheAttributes object - * + *

    * @return The maxPurgatorySize value */ public int getMaxPurgatorySize(); /** * Sets the maxPurgatorySize attribute of the DiskCacheAttributes object - * + *

    * @param maxPurgatorySize * The new maxPurgatorySize value */ @@ -66,7 +60,7 @@ /** * Get the amount of time in seconds we will wait for elements to move to * disk during shutdown for a particular region. - * + *

    * @return the time in seconds. */ public int getShutdownSpoolTimeLimit(); @@ -78,7 +72,7 @@ * This is how long we give the event queue to empty. *

    * The default is 60 seconds. - * + *

    * @param shutdownSpoolTimeLimit * the time in seconds */ @@ -86,17 +80,17 @@ /** * If this is true then remove all is not prohibited. - * + *

    * @return */ public boolean isAllowRemoveAll(); - + /** * If this is false, then remove all requests will not be honored. *

    * This provides a safety mechanism for the persistent store. + *

    * @param allowRemoveAll */ public void setAllowRemoveAll( boolean allowRemoveAll ); } -// end interface --------------------------------------------------------------------- To unsubscribe, e-mail: jcs-dev-unsubscribe@jakarta.apache.org For additional commands, e-mail: jcs-dev-help@jakarta.apache.org