Author: davsclaus
Date: Thu Dec 22 10:26:48 2011
New Revision: 1222158
URL: http://svn.apache.org/viewvc?rev=1222158&view=rev
Log:
CAMEL-4758: Improved javadoc. Thanks to Glen Mazza for patch.
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
camel/trunk/camel-core/src/main/java/org/apache/camel/IsSingleton.java
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java?rev=1222158&r1=1222157&r2=1222158&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
Thu Dec 22 10:26:48 2011
@@ -18,7 +18,9 @@
package org.apache.camel;
/**
- * An exception thrown for authorization errors occurring in a Camel exchange.
+ * An exception thrown for either authentication or authorization errors
occurring
+ * in a Camel exchange. Intended to be used when a user is denied an action
and
+ * Camel should not process the message as a result.
*
* @version
*/
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/IsSingleton.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/IsSingleton.java?rev=1222158&r1=1222157&r2=1222158&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/IsSingleton.java
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/IsSingleton.java Thu
Dec 22 10:26:48 2011
@@ -17,9 +17,14 @@
package org.apache.camel;
/**
- * Used for defining if a given class is singleton or not.
- * If the class is a Singleton, then a single instance will be shared. Because
the class is shared, it
- * should be treated as an immutable and be thread safe.
+ * Used for defining if a given class is singleton or not. If the class is a
singleton,
+ * then a single instance will be shared (and hence should be treated as
immutable and
+ * be used in a thread-safe manner.)
+ *
+ * This interface is not implemented as a marker interface (i.e., it's
necessary to read
+ * isSingleton() instead of instanceof(IsSingleton)). This allows for
subclasses to have
+ * a singleton status different from a parent and for objects to have this
value dynamically
+ * changed.
*
* @version
*/
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
URL:
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java?rev=1222158&r1=1222157&r2=1222158&view=diff
==============================================================================
---
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
(original)
+++
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
Thu Dec 22 10:26:48 2011
@@ -33,9 +33,9 @@ package org.apache.camel;
public interface MultipleConsumersSupport {
/**
- * Is multiple consumers supported?
+ * Are multiple consumers supported?
*
- * @return <tt>true</tt> if multiple consumers is supported
+ * @return <tt>true</tt> if multiple consumers are supported
*/
boolean isMultipleConsumersSupported();
}
