[jbosscache-commits] JBoss Cache SVN: r5431 - in pojo/trunk/src/main/java/org/jboss/cache/pojo: impl and 2 other directories.
jbosscache-commits at lists.jboss.org
jbosscache-commits at lists.jboss.org
Thu Mar 13 22:49:49 EDT 2008
Author: jason.greene at jboss.com
Date: 2008-03-13 22:49:48 -0400 (Thu, 13 Mar 2008)
New Revision: 5431
Modified:
pojo/trunk/src/main/java/org/jboss/cache/pojo/PojoCache.java
pojo/trunk/src/main/java/org/jboss/cache/pojo/impl/PojoCacheDelegate.java
pojo/trunk/src/main/java/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java
pojo/trunk/src/main/java/org/jboss/cache/pojo/util/ObjectUtil.java
Log:
Merge javadoc fixes from branches/2.1
Modified: pojo/trunk/src/main/java/org/jboss/cache/pojo/PojoCache.java
===================================================================
--- pojo/trunk/src/main/java/org/jboss/cache/pojo/PojoCache.java 2008-03-14 02:48:22 UTC (rev 5430)
+++ pojo/trunk/src/main/java/org/jboss/cache/pojo/PojoCache.java 2008-03-14 02:49:48 UTC (rev 5431)
@@ -12,6 +12,7 @@
import org.jboss.cache.Cache;
import org.jboss.cache.Fqn;
+import org.jboss.cache.pojo.annotation.Replicable;
import org.jboss.cache.pojo.notification.annotation.PojoCacheListener;
/**
@@ -23,6 +24,7 @@
* replication via fine-grained maner, i.e., only modified fields are replicated.</p>
*
* @author Ben Wang
+ * @author Jason T. Greene
* @since 2.0
*/
public interface PojoCache
@@ -31,7 +33,7 @@
* <p>Attach a POJO into PojoCache. It will also recursively put any
* sub-POJO into the cache system. A POJO can be the following and have the
* consqeuences when attached:</p> <p/> <li>it is Replicable, that is, it
- * has been annotated with {@link @org.jboss.cache.pojo.annotation.Replicable} annotation (or via XML),
+ * has been annotated with {@link Replicable} annotation (or via XML),
* and has
* been "instrumented" either compile- or load-time. The POJO will be mapped
* recursively to the system and fine-grained replication will be
@@ -47,8 +49,8 @@
* @param id An id String to identify the object in the cache. To promote
* concurrency, we recommend the use of hierarchical String separating by a
* designated separator. Default is "/" but it can be set differently via a
- * System property, jbosscache.separator in the future release. E.g., "ben",
- * or "student/joe", etc.
+ * System property, jbosscache.separator in the future release. E.g., "/ben",
+ * or "/student/joe", etc.
* @param pojo object to be inerted into the cache. If null, it will nullify
* the fqn node.
* @return Existing POJO or null if there is none.
@@ -59,26 +61,23 @@
/**
* <p>Attach a POJO into PojoCache. It will also recursively put any
* sub-POJO into the cache system. A POJO can be the following and have the
- * consqeuences when attached:</p> <p/> <li>it is Replicable, that is, it
- * has been annotated with {@link @org.jboss.cache.pojo.annotation.Replicable} annotation (or via XML),
+ * consequences when attached:</p> <p/> <li>it is Replicable, that is, it
+ * has been annotated with {@link Replicable} annotation (or via XML),
* and has
* been "instrumented" either compile- or load-time. The POJO will be mapped
* recursively to the system and fine-grained replication will be
* performed.</li> <li>It is Serializable. The POJO will still be stored in
* the cache system. However, it is treated as an "opaque" object per se.
* That is, the POJO will neither be intercepted
- * (for fine-grained operation) or object relantionship will be
+ * (for fine-grained operation) or object relationship will be
* maintained.</li>
* <li>Neither of above. In this case, a user can specify whether it wants
* this POJO to be stored (e.g., replicated or persistent). If not, a
* PojoCacheException will be thrown.</li>
*
- * @param id An id String to identify the object in the cache. To promote
- * concurrency, we recommend the use of hierarchical String separating by a
- * designated separator. Default is "/" but it can be set differently via a
- * System property, jbosscache.separator in the future release. E.g., "ben",
- * or "student/joe", etc.
- * @param pojo object to be inerted into the cache. If null, it will nullify
+ * @since 2.1
+ * @param id the Fqn that specifies the location in the cache to attach the object
+ * @param pojo object to be inserted into the cache. If null, it will nullify
* the fqn node.
* @return Existing POJO or null if there is none.
* @throws PojoCacheException Throws if there is an error related to the cache operation.
@@ -97,6 +96,7 @@
/**
* Remove POJO object from the cache.
*
+ * @since 2.1
* @param id location of the object to remove
* @return Original value object from this node.
* @throws PojoCacheException Throws if there is an error related to the cache operation.
@@ -116,6 +116,7 @@
* Determines if an object is attached at a particular location. This is somewhat less expensive
* than find() because an object is not created, and internal reference links are not traversed.
*
+ * @since 2.1
* @param id the location in the cache to examine
* @return true if an attached object exists, false if not
*/
@@ -135,6 +136,7 @@
* Retrieve POJO from the cache system. Return null if object does not exist in the cache.
* Note that this operation is fast if there is already a POJO instance attached to the cache.
*
+ * @since 2.1
* @param id that associates with this node.
* @return Current content value. Null if does not exist.
* @throws PojoCacheException Throws if there is an error related to the cache operation.
@@ -161,6 +163,7 @@
* now. In addition, it assumes that once a POJO is found with a id, no more POJO is stored
* under the children of the id. That is, we don't mix the id with different POJOs.
*
+ * @since 2.1
* @param id The starting place to find all POJOs.
* @return Map of all POJOs found with (id, POJO) pair. Return size of 0, if not found.
* @throws PojoCacheException Throws if there is an error related to the cache operation.
Modified: pojo/trunk/src/main/java/org/jboss/cache/pojo/impl/PojoCacheDelegate.java
===================================================================
--- pojo/trunk/src/main/java/org/jboss/cache/pojo/impl/PojoCacheDelegate.java 2008-03-14 02:48:22 UTC (rev 5430)
+++ pojo/trunk/src/main/java/org/jboss/cache/pojo/impl/PojoCacheDelegate.java 2008-03-14 02:49:48 UTC (rev 5431)
@@ -223,7 +223,7 @@
* Note that caller of this method will take care of synchronization within the <code>fqn</code> sub-tree.
*
* @param fqn
- * @return
+ * @return detached object
* @throws CacheException
*/
public Object removeObject(Fqn fqn, String field) throws CacheException
Modified: pojo/trunk/src/main/java/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java
===================================================================
--- pojo/trunk/src/main/java/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java 2008-03-14 02:48:22 UTC (rev 5430)
+++ pojo/trunk/src/main/java/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java 2008-03-14 02:49:48 UTC (rev 5431)
@@ -21,7 +21,6 @@
*/
package org.jboss.cache.pojo.jmx;
-import org.jboss.cache.Cache;
import org.jboss.cache.CacheStatus;
import org.jboss.cache.config.Configuration;
import org.jboss.cache.jmx.LegacyConfiguration;
@@ -115,20 +114,20 @@
Configuration getConfiguration();
/**
- * Gets whether this object should register a {@link CacheJmxWrapperMBean}
- * for the underlying {@link Cache} with JMX.
+ * Gets whether this object should register a {@link PojoCacheJmxWrapperMBean}
+ * for the underlying {@link PojoCache} with JMX.
* <p/>
* Default is <code>true</code>.
*/
boolean getRegisterPlainCache();
/**
- * Sets whether this object should register a {@link CacheJmxWrapperMBean}
- * for the underlying {@link Cache} with JMX.
+ * Sets whether this object should register a {@link PojoCacheJmxWrapperMBean}
+ * for the underlying {@link PojoCache} with JMX.
* <p/>
* Default is <code>true</code>.
* <p/>
- * If <code>true</code>, the <code>CacheJmxWrapperMBean</code> will be
+ * If <code>true</code>, the <code>PojoCacheJmxWrapperMBean</code> will be
* instantiated and registered either as part of the registration of
* this object, or during the call to {@link #create()}.
*/
Modified: pojo/trunk/src/main/java/org/jboss/cache/pojo/util/ObjectUtil.java
===================================================================
--- pojo/trunk/src/main/java/org/jboss/cache/pojo/util/ObjectUtil.java 2008-03-14 02:48:22 UTC (rev 5430)
+++ pojo/trunk/src/main/java/org/jboss/cache/pojo/util/ObjectUtil.java 2008-03-14 02:49:48 UTC (rev 5431)
@@ -38,7 +38,7 @@
* @param cache
* @param originalObject
* @param thisObject
- * @return
+ * @return true if reachable
* @throws CacheException
*/
public static boolean isReachable(PojoCacheImpl cache, Object originalObject, Object thisObject)
More information about the jbosscache-commits
mailing list