Return-Path: Delivered-To: apmail-jackrabbit-commits-archive@www.apache.org Received: (qmail 80458 invoked from network); 19 May 2010 13:14:16 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 19 May 2010 13:14:16 -0000 Received: (qmail 3966 invoked by uid 500); 19 May 2010 13:14:16 -0000 Delivered-To: apmail-jackrabbit-commits-archive@jackrabbit.apache.org Received: (qmail 3918 invoked by uid 500); 19 May 2010 13:14:15 -0000 Mailing-List: contact commits-help@jackrabbit.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@jackrabbit.apache.org Delivered-To: mailing list commits@jackrabbit.apache.org Received: (qmail 3911 invoked by uid 99); 19 May 2010 13:14:15 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 19 May 2010 13:14:15 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 19 May 2010 13:14:12 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 4FB1A23888FE; Wed, 19 May 2010 13:13:50 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r946172 - in /jackrabbit/trunk: jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/ jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ Date: Wed, 19 May 2010 13:13:50 -0000 To: commits@jackrabbit.apache.org From: angela@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100519131350.4FB1A23888FE@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: angela Date: Wed May 19 13:13:49 2010 New Revision: 946172 URL: http://svn.apache.org/viewvc?rev=946172&view=rev Log: javadoc Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/AbstractReadableRepositoryService.java jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/ItemInfoCacheImpl.java jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/AbstractReadableRepositoryService.java URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/AbstractReadableRepositoryService.java?rev=946172&r1=946171&r2=946172&view=diff ============================================================================== --- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/AbstractReadableRepositoryService.java (original) +++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/AbstractReadableRepositoryService.java Wed May 19 13:13:49 2010 @@ -94,14 +94,12 @@ public abstract class AbstractReadableRe this.defaulWsp = defaultWsp; } - //---------------------< may be overwritten by subclasses>------------------ - - + //------------------------------------< may be overwritten by subclasses>--- /** * Checks whether the workspaceName is valid. * @param workspaceName name of the workspace to check * @throws NoSuchWorkspaceException if workspaceName is neither in the - * list of workspaces nor null (i.e. default workspace). + * list of workspace nor null (i.e. default workspace). */ @Override protected void checkWorkspace(String workspaceName) throws NoSuchWorkspaceException { @@ -117,14 +115,16 @@ public abstract class AbstractReadableRe return super.createSessionInfo(credentials, workspaceName == null? defaulWsp : workspaceName); } - // -----------------------------------------------------< cache >--- - + // -------------------------------------------------------------< cache >--- + /** + * @param sessionInfo + * @return a new instance of ItemInfoCacheImpl + */ public ItemInfoCache getItemInfoCache(SessionInfo sessionInfo) { return new ItemInfoCacheImpl(); } - //-----------------------------< reading >---------------------------------- - + //------------------------------------------------------------< reading >--- /** * This default implementation returns the first item returned by the call to * {@link #getItemInfos(SessionInfo, NodeId)}. The underlying assumption here is that @@ -145,8 +145,7 @@ public abstract class AbstractReadableRe } } - //-------------------------< workspace names >------------------------------ - + //----------------------------------------------------< workspace names >--- /** * This default implementation first calls {@link #checkSessionInfo(SessionInfo)} * with the sessionInfo, then returns the workspaces that were @@ -157,8 +156,7 @@ public abstract class AbstractReadableRe return wspNames.toArray(new String[wspNames.size()]); } - //-------------------------< access control >------------------------------- - + //-----------------------------------------------------< access control >--- /** * This default implementation first calls {@link #checkSessionInfo(SessionInfo)} * with the sessionInfo, then returns false if Modified: jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/ItemInfoCacheImpl.java URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/ItemInfoCacheImpl.java?rev=946172&r1=946171&r2=946172&view=diff ============================================================================== --- jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/ItemInfoCacheImpl.java (original) +++ jackrabbit/trunk/jackrabbit-spi-commons/src/main/java/org/apache/jackrabbit/spi/commons/ItemInfoCacheImpl.java Wed May 19 13:13:49 2010 @@ -29,13 +29,15 @@ import org.apache.jackrabbit.spi.Reposit /** * This implementation of {@link ItemInfoCache} has a default size of 5000 items. * Item infos are put into the cache after they have been read from the {@link RepositoryService}. - * If the cache is full, the oldest item is discared. Reading items removes the from the cache. + * If the cache is full, the oldest item is discarded. Reading items removes the + * from the cache. * * The underlying idea here is, that {@link ItemInfo}s which are supplied by the - * RepositoryService but not immediately needed are put into the cache to avoid further - * round trips to RepositoryService. When they are needed later, they are read - * from the cache. There is no need to keep them in this cache after that point since they are - * present in the hierarchy from then on. + * RepositoryService but not immediately needed are put into the + * cache to avoid further round trips to RepositoryService. + * When they are needed later, they are read from the cache. There is no need to + * keep them in this cache after that point since they are present in the + * hierarchy from then on. */ public class ItemInfoCacheImpl implements ItemInfoCache { Modified: jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java URL: http://svn.apache.org/viewvc/jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java?rev=946172&r1=946171&r2=946172&view=diff ============================================================================== --- jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java (original) +++ jackrabbit/trunk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/ItemInfoCache.java Wed May 19 13:13:49 2010 @@ -17,21 +17,21 @@ package org.apache.jackrabbit.spi; /** - * ItemInfoCache instances are responsible for caching {@link ItemInfo}s along with an - * opaque generation counter. Implementors are free on the particular caching policy. That is, how - * long (if at all) item infos are cached. + * ItemInfoCache instances are responsible for caching + * {@link ItemInfo}s along with an opaque generation counter. Implementations + * are free on the particular caching policy. That is, how long (if at all) item + * infos are cached. * * An ItemInfoCache is supplied per session from the {@link RepositoryService}. It is used * to cache ItemInfos read from the RepositoryService. * * @see RepositoryService#getItemInfos(SessionInfo, NodeId) - * @see org.apache.jackrabbit.spi.commons.ItemInfoCacheImpl */ public interface ItemInfoCache { /** * This class represents a cache entry. - * @param Wither a {@link NodeInfo} or a {@link PropertyInfo}. + * @param Either a {@link NodeInfo} or a {@link PropertyInfo}. */ class Entry { @@ -80,20 +80,22 @@ public interface ItemInfoCache { } /** - * Retreive a cache entry for the given nodeId or null + * Retrieve a cache entry for the given nodeId or null * if no such entry is in the cache. * - * @param nodeId id of the entry to lookup - * @return a Entry<NodeInfo> instance or null if not found + * @param nodeId id of the entry to lookup. + * @return a Entry<NodeInfo> instance or null + * if not found. */ ItemInfoCache.Entry getNodeInfo(NodeId nodeId); /** - * Retreive a cache entry for the given propertyId or null + * Retrieve a cache entry for the given propertyId or null * if no such entry is in the cache. * - * @param propertyId id of the entry to lookup - * @return a Entry<PropertyInfo> instance or null if not found + * @param propertyId id of the entry to lookup. + * @return a Entry<PropertyInfo> instance or + * null if not found. */ ItemInfoCache.Entry getPropertyInfo(PropertyId propertyId);