[jbosscache-commits] JBoss Cache SVN: r6655 - in core/trunk/src/main/java/org/jboss/cache: config and 8 other directories.

Author: manik.surtani(a)jboss.com Date: 2008-09-02 01:41:26 -0400 (Tue, 02 Sep 2008) New Revision: 6655 Modified: core/trunk/src/main/java/org/jboss/cache/CacheManager.java core/trunk/src/main/java/org/jboss/cache/NodeFactory.java core/trunk/src/main/java/org/jboss/cache/Region.java core/trunk/src/main/java/org/jboss/cache/UnversionedNode.java core/trunk/src/main/java/org/jboss/cache/config/ConfigurationRegistry.java core/trunk/src/main/java/org/jboss/cache/config/RuntimeConfig.java core/trunk/src/main/java/org/jboss/cache/config/parsing/XmlParserBase.java core/trunk/src/main/java/org/jboss/cache/factories/annotations/Inject.java core/trunk/src/main/java/org/jboss/cache/interceptors/TxInterceptor.java core/trunk/src/main/java/org/jboss/cache/jmx/CacheJmxWrapperMBean.java core/trunk/src/main/java/org/jboss/cache/loader/SingletonStoreCacheLoader.java core/trunk/src/main/java/org/jboss/cache/loader/tcp/TcpCacheServerMBean.java core/trunk/src/main/java/org/jboss/cache/lock/LockManager.java core/trunk/src/main/java/org/jboss/cache/lock/LockMap.java core/trunk/src/main/java/org/jboss/cache/util/DeltaMap.java core/trunk/src/main/java/org/jboss/cache/util/Immutables.java Log: Fixed up javadoc errors Modified: core/trunk/src/main/java/org/jboss/cache/CacheManager.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/CacheManager.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/CacheManager.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -7,87 +7,87 @@ package org.jboss.cache; -import java.util.Set; - import org.jboss.cache.config.Configuration; import org.jgroups.ChannelFactory; +import java.util.Set; + /** * Factory and registry for JBoss Cache instances configured using * named configurations. - * + * * @author <a href=&quot;brian.stansberry(a)jboss.com&quot;&gt;Brian Stansberry</a> * @version $Revision: 1 $ */ -public interface CacheManager { +public interface CacheManager +{ - /** - * Gets the names of all the configurations of which this object - * is aware. - * - * @return a set of names. Will not be <code>null</code>. - */ - Set<String> getConfigurationNames(); - - /** - * Gets the name of all caches that are registered, i.e. that can be - * by a call to {@link #getCache(String, boolean) getCache(name, false)}. - * - * @return a set of names. Will not be <code>null</code>. - */ - Set<String> getCacheNames(); - - /** - * Gets the JGroups <code>ChannelFactory</code> that will be injected - * into any {@link Configuration} that has a - * {@link Configuration#getMultiplexerStack() multiplexer stack} - * configured. - * - * @return - */ - ChannelFactory getChannelFactory(); - - /** - * Get a cache configured according to the given configuration name, - * optionally instantiating the cache if it hasn't already been - * instantiated. - * <p> - * The caller is free to invoke the {@link Cache#create()} and - * {@link Cache#start()} lifecycle methods on the returned cache, but - * the @link Cache#stop()} and {@link Cache#destroy()} methods should not - * be invoked, since it is quite possible other users are still using the - * cache. Use {@link #releaseCache(String)} to notify this - * registry that the caller is no longer using a cache; let the registry - * control stopping and destroying the cache. - * </p> - * <p> - * If invoking this method leads to the instantiation of the cache, - * <code>create()</code> and <code>start()</code> will not be invoked - * on the cache before it is returned. - * </p> - * - * @param configName the name of the configuration - * @param create should the cache be instantiated if it - * hasn't already been? - * @return the cache, or <code>null</code> if - * <code>create</code> is false and the cache hasn't - * been created previously. - * - * @throws IllegalArgumentException if this object is unaware of - * <code>configName</code>; i.e. the set - * returned from {@link #getConfigurationNames()} - * does not include <code>configName</code> - * @throws Exception if there is a problem instantiating the cache - */ - Cache<Object, Object> getCache(String configName, boolean create) throws Exception; - - /** - * Notifies the registry that the caller is no longer using the given - * cache. The registry may perform cleanup operations, such as - * stopping and destroying the cache. - * - * @param configName - */ - void releaseCache(String configName); + /** + * Gets the names of all the configurations of which this object + * is aware. + * + * @return a set of names. Will not be <code>null</code>. + */ + Set<String> getConfigurationNames(); + /** + * Gets the name of all caches that are registered, i.e. that can be + * by a call to {@link #getCache(String, boolean) getCache(name, false)}. + * + * @return a set of names. Will not be <code>null</code>. + */ + Set<String> getCacheNames(); + + /** + * Gets the JGroups <code>ChannelFactory</code> that will be injected + * into any {@link Configuration} that has a + * {@link Configuration#getMultiplexerStack() multiplexer stack} + * configured. + * + * @return a channel factory + */ + ChannelFactory getChannelFactory(); + + /** + * Get a cache configured according to the given configuration name, + * optionally instantiating the cache if it hasn't already been + * instantiated. + * <p> + * The caller is free to invoke the {@link Cache#create()} and + * {@link Cache#start()} lifecycle methods on the returned cache, but + * the @link Cache#stop()} and {@link Cache#destroy()} methods should not + * be invoked, since it is quite possible other users are still using the + * cache. Use {@link #releaseCache(String)} to notify this + * registry that the caller is no longer using a cache; let the registry + * control stopping and destroying the cache. + * </p> + * <p> + * If invoking this method leads to the instantiation of the cache, + * <code>create()</code> and <code>start()</code> will not be invoked + * on the cache before it is returned. + * </p> + * + * @param configName the name of the configuration + * @param create should the cache be instantiated if it + * hasn't already been? + * @return the cache, or <code>null</code> if + * <code>create</code> is false and the cache hasn't + * been created previously. + * @throws IllegalArgumentException if this object is unaware of + * <code>configName</code>; i.e. the set + * returned from {@link #getConfigurationNames()} + * does not include <code>configName</code> + * @throws Exception if there is a problem instantiating the cache + */ + Cache<Object, Object> getCache(String configName, boolean create) throws Exception; + + /** + * Notifies the registry that the caller is no longer using the given + * cache. The registry may perform cleanup operations, such as + * stopping and destroying the cache. + * + * @param configName + */ + void releaseCache(String configName); + } \ No newline at end of file Modified: core/trunk/src/main/java/org/jboss/cache/NodeFactory.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/NodeFactory.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/NodeFactory.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -28,7 +28,7 @@ * @param fqn * @param parent * @param data - * @return + * @return a new node */ NodeSPI<K, V> createNode(Fqn fqn, NodeSPI<K, V> parent, Map<K, V> data); @@ -41,7 +41,7 @@ * @param childName * @param parent * @param data - * @return + * @return a new node */ NodeSPI<K, V> createNode(Object childName, NodeSPI<K, V> parent, Map<K, V> data); @@ -50,7 +50,7 @@ * * @param fqn * @param parent - * @return + * @return a new node */ NodeSPI<K, V> createNode(Fqn fqn, NodeSPI<K, V> parent); @@ -59,7 +59,7 @@ * * @param childName * @param parent - * @return + * @return a new node */ NodeSPI<K, V> createNode(Object childName, NodeSPI<K, V> parent); @@ -85,7 +85,7 @@ * in a {@link org.jboss.cache.invocation.NodeInvocationDelegate}. * * @param childFqn - * @return + * @return a new node */ InternalNode<K, V> createInternalNode(Fqn childFqn); } Modified: core/trunk/src/main/java/org/jboss/cache/Region.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/Region.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/Region.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -162,7 +162,7 @@ /** * Marks a {@link org.jboss.cache.Node} as currently in use, by adding an event to the eviction queue. * If there is an {@link org.jboss.cache.config.EvictionRegionConfig} associated with this region, and - * it respects this event (e.g., {@link org.jboss.cache.eviction.LRUSelector} does), then the {@link org.jboss.cache.Node} will not + * it respects this event (e.g., {@link org.jboss.cache.eviction.LRUAlgorithm} does), then the {@link org.jboss.cache.Node} will not * be evicted until {@link #unmarkNodeCurrentlyInUse(Fqn)} is invoked. * <p/> * This mechanism can be used to prevent eviction of data that the application Modified: core/trunk/src/main/java/org/jboss/cache/UnversionedNode.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/UnversionedNode.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/UnversionedNode.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -6,11 +6,13 @@ */ package org.jboss.cache; -import static org.jboss.cache.AbstractNode.NodeFlags.CHILDREN_LOADED; -import static org.jboss.cache.AbstractNode.NodeFlags.DATA_LOADED; -import static org.jboss.cache.AbstractNode.NodeFlags.LOCK_FOR_CHILD_INSERT_REMOVE; -import static org.jboss.cache.AbstractNode.NodeFlags.REMOVED; -import static org.jboss.cache.AbstractNode.NodeFlags.VALID; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import static org.jboss.cache.AbstractNode.NodeFlags.*; +import org.jboss.cache.marshall.MarshalledValue; +import org.jboss.cache.util.FastCopyHashMap; +import org.jboss.cache.util.Immutables; +import org.jboss.cache.util.concurrent.SelfInitializingConcurrentHashMap; import java.util.Collections; import java.util.HashMap; @@ -20,13 +22,6 @@ import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; -import org.apache.commons.logging.Log; -import org.apache.commons.logging.LogFactory; -import org.jboss.cache.marshall.MarshalledValue; -import org.jboss.cache.util.FastCopyHashMap; -import org.jboss.cache.util.Immutables; -import org.jboss.cache.util.concurrent.SelfInitializingConcurrentHashMap; - /** * Basic data node class. Throws {@link UnsupportedOperationException} for version-specific methods like {@link #getVersion()} and * {@link #setVersion(org.jboss.cache.optimistic.DataVersion)}, defined in {@link org.jboss.cache.NodeSPI}. @@ -96,7 +91,7 @@ /** * This method initialises flags on the node, by setting DATA_LOADED to true and VALID to true and all other flags to false. - * The flags are defined in the {@link NodeFlags} enum. + * The flags are defined in the {@link org.jboss.cache.AbstractNode.NodeFlags} enum. */ protected void initFlags() { Modified: core/trunk/src/main/java/org/jboss/cache/config/ConfigurationRegistry.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/config/ConfigurationRegistry.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/config/ConfigurationRegistry.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -11,20 +11,20 @@ /** * A registry for {@link Configuration}s. - * + * * @author Brian Stansberry * @version $Revision$ */ public interface ConfigurationRegistry { /** - * Gets a {@link Configuration#clone() clone} of the {@link Configuration} + * Gets a {@link Configuration#clone() clone} of the {@link Configuration} * registered under the given name. - * <p> + * <p/> * The returned object is a clone of the internally held configuration, * so any changes made to it by the caller will not affect the internal - * state of this registry. - * + * state of this registry. + * * @param configName the name of the configuration * @return a <code>Configuration</code>. Will not be <code>null</code>. * @throws IllegalArgumentException if no configuration is registered @@ -34,33 +34,32 @@ /** * Register the given configuration under the given name. - * <p> + * <p/> * The configuration will be cloned before being stored internally, * so the copy under the control of the registry will not be affected * by any external changes. - * + * * @param configName the name of the configuration * @param config the configuration - * * @throws CloneNotSupportedException - * @throws IllegalStateException if a configuration is already registered - * under <code>configName</code> + * @throws IllegalStateException if a configuration is already registered + * under <code>configName</code> */ void registerConfiguration(String configName, Configuration config) throws CloneNotSupportedException; - + /** * Unregisters the named configuration. - * + * * @param configName the name of the configuration * @throws IllegalStateException if no configuration is registered - * under <code>configName</code> + * under <code>configName</code> */ void unregisterConfiguration(String configName); /** * Gets the names of all registered configurations. - * - * @return + * + * @return a set of configuration names */ Set<String> getConfigurationNames(); } \ No newline at end of file Modified: core/trunk/src/main/java/org/jboss/cache/config/RuntimeConfig.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/config/RuntimeConfig.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/config/RuntimeConfig.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -50,11 +50,11 @@ /** * Sets the factory the cache should use to create a multiplexed channel. * Ignored if a Channel is directly configured via - * {@link {@link #setChannel(Channel)}. If the channel factory is set, + * {@link #setChannel(Channel)}. If the channel factory is set, * {@link Configuration#setMultiplexerStack(String)} must also be set, or * a <code>CacheException</code> will be thrown during cache startup. * - * @param multiplexerChannelFactory + * @param multiplexerChannelFactory channel factory */ public void setMuxChannelFactory(ChannelFactory multiplexerChannelFactory) { @@ -108,7 +108,7 @@ * the cache will create and use a mux channel. * </p> * - * @param channel + * @param channel channel to set */ public void setChannel(Channel channel) { Modified: core/trunk/src/main/java/org/jboss/cache/config/parsing/XmlParserBase.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/config/parsing/XmlParserBase.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/config/parsing/XmlParserBase.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -90,8 +90,8 @@ /** * Beside querying the element for it's attribute value, it will look into the value, if any, and replace the * jboss properties(e.g. ${someValue:defaultValue}. - * - * @see StringPropertyReplacer#replaceProperties(value); + * <p/> + * {@link org.jboss.util.StringPropertyReplacer#replaceProperties(String)} */ protected String getAttributeValue(Element element, String attrName) { Modified: core/trunk/src/main/java/org/jboss/cache/factories/annotations/Inject.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/factories/annotations/Inject.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/factories/annotations/Inject.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -8,7 +8,7 @@ /** * Used to annotate a method as one that is used to inject a registered component into another component. The component * to be constructed must be built using the {@link org.jboss.cache.factories.ComponentFactory#construct(Class)} method, or if your object that needs - * components injected into it already exists, it can be built using the {@link org.jboss.cache.factories.ComponentFactory#wireComponents(Object)} + * components injected into it already exists, it can be built using the {@link org.jboss.cache.factories.ComponentRegistry#wireDependencies(Object)} * method. * <p/> * Usage example: @@ -38,11 +38,8 @@ * <pre> * MyClass myClass = componentFactory.construct(MyClass.class); // instance will have dependencies injected. * </pre> - * If you wish to use named components, you can use the optional {@link org.jboss.cache.factories.annotations.ComponentName} - * annotation on each parameter. * * @author Manik Surtani - * @see ComponentName * @since 2.1.0 */ // ensure this annotation is available at runtime. Modified: core/trunk/src/main/java/org/jboss/cache/interceptors/TxInterceptor.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/interceptors/TxInterceptor.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/interceptors/TxInterceptor.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -10,9 +10,6 @@ import org.jboss.cache.InvocationContext; import org.jboss.cache.RPCManager; import org.jboss.cache.ReplicationException; -import org.jboss.cache.jmx.annotations.MBean; -import org.jboss.cache.jmx.annotations.ManagedAttribute; -import org.jboss.cache.jmx.annotations.ManagedOperation; import org.jboss.cache.commands.AbstractVisitor; import org.jboss.cache.commands.CommandsFactory; import org.jboss.cache.commands.ReplicableCommand; @@ -33,6 +30,8 @@ import org.jboss.cache.factories.annotations.Inject; import org.jboss.cache.factories.context.ContextFactory; import org.jboss.cache.invocation.InvocationContextContainer; +import org.jboss.cache.jmx.annotations.ManagedAttribute; +import org.jboss.cache.jmx.annotations.ManagedOperation; import org.jboss.cache.lock.LockManager; import org.jboss.cache.notifications.Notifier; import org.jboss.cache.transaction.GlobalTransaction; @@ -247,7 +246,6 @@ * Tests if we already have a tx running. If so, register a sync handler for this method invocation. * if not, create a local tx if we're using opt locking. * - * @return * @throws Throwable */ @Override @@ -452,12 +450,6 @@ /** * Replays modifications - * - * @param ctx - * @param ltx - * @param command - * @return - * @throws Exception */ protected void replayModifications(InvocationContext ctx, Transaction ltx, PrepareCommand command) throws Throwable { @@ -493,7 +485,6 @@ * Handles a commit or a rollback. Called by the synch handler. Simply tests that we are in the correct tx and * passes the meth call up the interceptor chain. * - * @return * @throws Throwable */ @SuppressWarnings("deprecation") @@ -800,7 +791,6 @@ /** * Creates and starts a local tx * - * @return * @throws Exception */ protected Transaction createLocalTx() throws Exception @@ -1126,19 +1116,19 @@ this.statsEnabled = enabled; } - @ManagedAttribute (description = "number of transaction prepares") + @ManagedAttribute(description = "number of transaction prepares") public long getPrepares() { return prepares; } - @ManagedAttribute (description = "number of transaction commits") + @ManagedAttribute(description = "number of transaction commits") public long getCommits() { return commits; } - @ManagedAttribute (description = "number of transaction rollbacks") + @ManagedAttribute(description = "number of transaction rollbacks") public long getRollbacks() { return rollbacks; Modified: core/trunk/src/main/java/org/jboss/cache/jmx/CacheJmxWrapperMBean.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/jmx/CacheJmxWrapperMBean.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/jmx/CacheJmxWrapperMBean.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -162,7 +162,7 @@ /** * Gets whether this object should register the cache's interceptors - * with JMX during {@link {@link #create()}. + * with JMX during {@link #create()}. * <p/> * Default is <code>true</code>. */ Modified: core/trunk/src/main/java/org/jboss/cache/loader/SingletonStoreCacheLoader.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/loader/SingletonStoreCacheLoader.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/loader/SingletonStoreCacheLoader.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -141,12 +141,12 @@ { super.setCache(c); } - + @Override public void create() throws Exception { super.create(); - + cache.addCacheListener(new SingletonStoreListener()); } @@ -154,7 +154,7 @@ * Protected constructor which should only be used from unit tests. Production code should set * pushStateWhenCoordinator using setConfig() method instead. * - * @param SingletonStoreDefaultConfig configuration instance for SingletonStoreCacheLoader + * @param config configuration instance for SingletonStoreCacheLoader */ protected SingletonStoreCacheLoader(SingletonStoreDefaultConfig config) { Modified: core/trunk/src/main/java/org/jboss/cache/loader/tcp/TcpCacheServerMBean.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/loader/tcp/TcpCacheServerMBean.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/loader/tcp/TcpCacheServerMBean.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -1,14 +1,13 @@ package org.jboss.cache.loader.tcp; import org.jboss.cache.Cache; -import org.jboss.cache.CacheSPI; import org.jboss.cache.jmx.CacheJmxWrapperMBean; import java.net.UnknownHostException; /** * StandardMBean interface for {@link TcpCacheServer}. - * + * * @author Bela Ban * @author Brian Stansberry * @version $Id$ @@ -22,7 +21,7 @@ void stop(); void destroy(); - + String getBindAddress(); void setBindAddress(String bind_addr) throws UnknownHostException; @@ -37,18 +36,6 @@ Cache getCache(); - // BES 2007/5/22 Don't expose this setter via MBean interface, as - // it's a different type from getter, which is invalid. This - // setter doesn't need to be exposed vai JMX; the CacheJmxWrapper - // is sufficient, and the setter is still there in the impl. - //void setCache(CacheSPI cache); - - /** - * Allows {@link #setCache(CacheSPI) injection of the CacheSPI} via - * a {@link CacheJmxWrapperMBean}. - * - * @param wrapper - */ void setCacheJmxWrapper(CacheJmxWrapperMBean wrapper); String getConnections(); Modified: core/trunk/src/main/java/org/jboss/cache/lock/LockManager.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/lock/LockManager.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/lock/LockManager.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -314,7 +314,7 @@ /** * Prints lock information for all locks. * - * @return + * @return lock information */ String printLockInfo(); } Modified: core/trunk/src/main/java/org/jboss/cache/lock/LockMap.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/lock/LockMap.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/lock/LockMap.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -52,7 +52,7 @@ * @param caller the potential owner. Cannot be <code>null</code>. * @param ownership Either <code>OWNER_ANY</code>, <code>OWNER_READ</code>, * or <code>OWNER_WRITE</code>. - * @return + * @return true if the caller is the owner of the current lock * @throws NullPointerException if <code>caller</code> is <code>null</code>. */ public boolean isOwner(Object caller, int ownership) @@ -183,7 +183,7 @@ /** * Debugging information. * - * @return + * @return lock information */ public String printInfo() { Modified: core/trunk/src/main/java/org/jboss/cache/util/DeltaMap.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/util/DeltaMap.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/util/DeltaMap.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -90,7 +90,7 @@ * Creates and returns a DeltaMap for an original map, excluding some key mappings. * * @param original will not be modified, except by {@link #commit()} - * @param excluded entries not to include + * @param exclude entries not to include * @return a new instance */ public static <K, V> DeltaMap<K, V> excludeKeys(Map<K, V> original, Set<K> exclude) Modified: core/trunk/src/main/java/org/jboss/cache/util/Immutables.java =================================================================== --- core/trunk/src/main/java/org/jboss/cache/util/Immutables.java 2008-09-01 14:48:45 UTC (rev 6654) +++ core/trunk/src/main/java/org/jboss/cache/util/Immutables.java 2008-09-02 05:41:26 UTC (rev 6655) @@ -32,10 +32,10 @@ import java.util.LinkedHashSet; import java.util.List; import java.util.Map; +import java.util.Map.Entry; import java.util.Set; import java.util.TreeMap; import java.util.TreeSet; -import java.util.Map.Entry; /** * Factory for generating immutable type wrappers. @@ -47,7 +47,7 @@ /** * Whether or not this collection type is immutable * - * @param a Collection, Set, List, or Map + * @param o a Collection, Set, List, or Map * @return true if immutable, false if not */ public static boolean isImmutable(Object o) @@ -150,9 +150,9 @@ * @param map the map to wrap * @return an immutable map wrapper that delegates to the original map */ - public static <K,V> Map<K,V> immutableMapWrap(Map<? extends K, ? extends V> map) + public static <K, V> Map<K, V> immutableMapWrap(Map<? extends K, ? extends V> map) { - return new ImmutableMapWrapper<K,V>(map); + return new ImmutableMapWrapper<K, V>(map); } /** @@ -161,7 +161,7 @@ * @param map the map to copy from * @return an immutable map copy */ - public static <K,V> Map<K,V> immutableMapCopy(Map<? extends K, ? extends V> map) + public static <K, V> Map<K, V> immutableMapCopy(Map<? extends K, ? extends V> map) { Map<? extends K, ? extends V> copy = attemptKnownMapCopy(map); @@ -170,9 +170,9 @@ if (copy == null) copy = attemptCopyConstructor(map, Map.class); if (copy == null) - copy = new HashMap<K,V>(map); + copy = new HashMap<K, V>(map); - return new ImmutableMapWrapper<K,V>(copy); + return new ImmutableMapWrapper<K, V>(copy); } /** @@ -198,13 +198,13 @@ private static <T extends Map> T attemptKnownMapCopy(T map) { if (map instanceof FastCopyHashMap) - return (T)((FastCopyHashMap) map).clone(); + return (T) ((FastCopyHashMap) map).clone(); if (map instanceof HashMap) - return (T)((HashMap) map).clone(); + return (T) ((HashMap) map).clone(); if (map instanceof LinkedHashMap) - return (T)((LinkedHashMap) map).clone(); + return (T) ((LinkedHashMap) map).clone(); if (map instanceof TreeMap) - return (T)((TreeMap) map).clone(); + return (T) ((TreeMap) map).clone(); return null; } @@ -213,11 +213,11 @@ private static <T extends Collection> T attemptKnownSetCopy(T set) { if (set instanceof HashSet) - return (T)((HashSet) set).clone(); + return (T) ((HashSet) set).clone(); if (set instanceof LinkedHashSet) - return (T)((LinkedHashSet) set).clone(); + return (T) ((LinkedHashSet) set).clone(); if (set instanceof TreeSet) - return (T)((TreeSet) set).clone(); + return (T) ((TreeSet) set).clone(); return null; } @@ -383,7 +383,6 @@ } - private static class ImmutableSetWrapper<E> extends ImmutableCollectionWrapper<E> implements Set<E>, Serializable, Immutable { private static final long serialVersionUID = 7991492805176142615L; @@ -431,10 +430,10 @@ @SuppressWarnings("unchecked") public boolean equals(Object o) { - if (! (o instanceof Map.Entry)) + if (!(o instanceof Map.Entry)) return false; - Map.Entry<K,V> entry = (Map.Entry<K,V>) o; + Map.Entry<K, V> entry = (Map.Entry<K, V>) o; return eq(entry.getKey(), key) && eq(entry.getValue(), value); } @@ -449,14 +448,14 @@ } } - private static class ImmutableEntrySetWrapper<K,V> extends ImmutableSetWrapper<Map.Entry<K, V>> + private static class ImmutableEntrySetWrapper<K, V> extends ImmutableSetWrapper<Map.Entry<K, V>> { private static final long serialVersionUID = 6378667653889667692L; @SuppressWarnings("unchecked") public ImmutableEntrySetWrapper(Set<? extends Map.Entry<? extends K, ? extends V>> set) { - super((Set<Entry<K, V>>)set); + super((Set<Entry<K, V>>) set); } public Object[] toArray() @@ -483,18 +482,19 @@ return array; } - public Iterator<Map.Entry<K,V>> iterator() + public Iterator<Map.Entry<K, V>> iterator() { - return new ImmutableIteratorWrapper<Entry<K,V>>(collection.iterator()) { + return new ImmutableIteratorWrapper<Entry<K, V>>(collection.iterator()) + { public Entry<K, V> next() { - return new ImmutableEntry<K,V>(super.next()); + return new ImmutableEntry<K, V>(super.next()); } }; } } - private static class ImmutableMapWrapper<K,V> implements Map<K,V>, Serializable, Immutable + private static class ImmutableMapWrapper<K, V> implements Map<K, V>, Serializable, Immutable { private static final long serialVersionUID = 708144227046742221L; @@ -522,7 +522,7 @@ public Set<Entry<K, V>> entrySet() { - return new ImmutableEntrySetWrapper<K,V>(map.entrySet()); + return new ImmutableEntrySetWrapper<K, V>(map.entrySet()); } public boolean equals(Object o)