You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by an...@apache.org on 2010/05/19 15:13:50 UTC
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/
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 <code>workspaceName</code> is valid.
* @param workspaceName name of the workspace to check
* @throws NoSuchWorkspaceException if <code>workspaceName</code> 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 <code>ItemInfoCacheImpl</code>
+ */
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 <code>sessionInfo</code>, 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 <code>sessionInfo</code>, then returns <code>false</code> 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
- * <code>RepositoryService</code> but not immediately needed are put into the cache to avoid further
- * round trips to <code>RepositoryService</code>. 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.
+ * <code>RepositoryService</code> but not immediately needed are put into the
+ * cache to avoid further round trips to <code>RepositoryService</code>.
+ * 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;
/**
- * <code>ItemInfoCache</code> 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.
+ * <code>ItemInfoCache</code> 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 <code>ItemInfoCache</code> is supplied per session from the {@link RepositoryService}. It is used
* to cache <code>ItemInfo</code>s read from the <code>RepositoryService</code>.
*
* @see RepositoryService#getItemInfos(SessionInfo, NodeId)
- * @see org.apache.jackrabbit.spi.commons.ItemInfoCacheImpl
*/
public interface ItemInfoCache {
/**
* This class represents a cache entry.
- * @param <T> Wither a {@link NodeInfo} or a {@link PropertyInfo}.
+ * @param <T> Either a {@link NodeInfo} or a {@link PropertyInfo}.
*/
class Entry<T extends ItemInfo> {
@@ -80,20 +80,22 @@ public interface ItemInfoCache {
}
/**
- * Retreive a cache entry for the given <code>nodeId</code> or <code>null</code>
+ * Retrieve a cache entry for the given <code>nodeId</code> or <code>null</code>
* if no such entry is in the cache.
*
- * @param nodeId id of the entry to lookup
- * @return a <code>Entry<NodeInfo></code> instance or <code>null</code> if not found
+ * @param nodeId id of the entry to lookup.
+ * @return a <code>Entry<NodeInfo></code> instance or <code>null</code>
+ * if not found.
*/
ItemInfoCache.Entry<NodeInfo> getNodeInfo(NodeId nodeId);
/**
- * Retreive a cache entry for the given <code>propertyId</code> or <code>null</code>
+ * Retrieve a cache entry for the given <code>propertyId</code> or <code>null</code>
* if no such entry is in the cache.
*
- * @param propertyId id of the entry to lookup
- * @return a <code>Entry<PropertyInfo></code> instance or <code>null</code> if not found
+ * @param propertyId id of the entry to lookup.
+ * @return a <code>Entry<PropertyInfo></code> instance or
+ * <code>null</code> if not found.
*/
ItemInfoCache.Entry<PropertyInfo> getPropertyInfo(PropertyId propertyId);