directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ersi...@apache.org
Subject svn commit: r328339 - /directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/
Date Tue, 25 Oct 2005 11:44:08 GMT
Author: ersiner
Date: Tue Oct 25 04:43:56 2005
New Revision: 328339

URL: http://svn.apache.org/viewcvs?rev=328339&view=rev
Log:
Added some javadocs.

Modified:
    directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/AbstractSimpleComponentsMonitor.java
    directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/ComponentsMonitor.java
    directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryAndOptionalComponentsMonitor.java
    directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryComponentsMonitor.java
    directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/OptionalComponentsMonitor.java

Modified: directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/AbstractSimpleComponentsMonitor.java
URL: http://svn.apache.org/viewcvs/directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/AbstractSimpleComponentsMonitor.java?rev=328339&r1=328338&r2=328339&view=diff
==============================================================================
--- directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/AbstractSimpleComponentsMonitor.java
(original)
+++ directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/AbstractSimpleComponentsMonitor.java
Tue Oct 25 04:43:56 2005
@@ -25,6 +25,12 @@
 import java.util.List;
 
 
+/**
+ * A monitoring set where all elements are mandatory or optional.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$
+ */
 public abstract class AbstractSimpleComponentsMonitor implements ComponentsMonitor
 {
     private List components;

Modified: directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/ComponentsMonitor.java
URL: http://svn.apache.org/viewcvs/directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/ComponentsMonitor.java?rev=328339&r1=328338&r2=328339&view=diff
==============================================================================
--- directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/ComponentsMonitor.java
(original)
+++ directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/ComponentsMonitor.java
Tue Oct 25 04:43:56 2005
@@ -2,11 +2,18 @@
 
 import java.util.List;
 
+/**
+ * A monitoring set. Can be implemented to provide control for component order,
+ * component existance, component duplication, etc.
+ * 
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$
+ */
 public interface ComponentsMonitor
 {
     public ComponentsMonitor useComponent( String component ) throws IllegalArgumentException;
     public boolean allComponentsUsed();
     public boolean finalStateValid();
     public List getRemainingComponents();
-    
 }

Modified: directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryAndOptionalComponentsMonitor.java
URL: http://svn.apache.org/viewcvs/directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryAndOptionalComponentsMonitor.java?rev=328339&r1=328338&r2=328339&view=diff
==============================================================================
--- directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryAndOptionalComponentsMonitor.java
(original)
+++ directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryAndOptionalComponentsMonitor.java
Tue Oct 25 04:43:56 2005
@@ -23,12 +23,25 @@
 import java.util.LinkedList;
 import java.util.List;
 
-
+/**
+ * A monitoring set where elements are mandatory either optional.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$
+ */
 public class MandatoryAndOptionalComponentsMonitor implements ComponentsMonitor
 {
     private ComponentsMonitor mandatoryComponentsMonitor;
     private ComponentsMonitor optionalComponentsMonitor;
     
+    /**
+     * Creates a MandatoryAndOptionalComponentsMonitor instance.
+     * 
+     * @param mandatoryComponents
+     * @param optionalComponents
+     * @throws IllegalArgumentException if mandatoryComponents and
+     * optionalComponents contain common components.
+     */
     public MandatoryAndOptionalComponentsMonitor( String [] mandatoryComponents,
             String [] optionalComponents ) throws IllegalArgumentException
     {
@@ -78,6 +91,12 @@
             optionalComponentsMonitor.allComponentsUsed() );
     }
 
+    /**
+     * Returns true if all both mandatoryComponents set and optionalComponents
+     * set have valid states.
+     * A mandatory components set can be in a valid final state if all components
+     * are used. An optional components set always has a valid final state.
+     */
     public boolean finalStateValid()
     {
         return ( mandatoryComponentsMonitor.finalStateValid() && 
@@ -93,5 +112,4 @@
         
         return Collections.unmodifiableList( remainingComponents );
     }
-
 }

Modified: directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryComponentsMonitor.java
URL: http://svn.apache.org/viewcvs/directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryComponentsMonitor.java?rev=328339&r1=328338&r2=328339&view=diff
==============================================================================
--- directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryComponentsMonitor.java
(original)
+++ directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/MandatoryComponentsMonitor.java
Tue Oct 25 04:43:56 2005
@@ -19,6 +19,12 @@
 package org.apache.ldap.common.util;
 
 
+/**
+ * A monitoring set where all elements are mandatory.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$
+ */
 public class MandatoryComponentsMonitor extends AbstractSimpleComponentsMonitor
 {
     public MandatoryComponentsMonitor( String [] components )
@@ -26,6 +32,9 @@
         super( components );
     }
 
+    /**
+     * Returns true if all components registered are used.
+     */
     public boolean finalStateValid()
     {
         return allComponentsUsed();

Modified: directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/OptionalComponentsMonitor.java
URL: http://svn.apache.org/viewcvs/directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/OptionalComponentsMonitor.java?rev=328339&r1=328338&r2=328339&view=diff
==============================================================================
--- directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/OptionalComponentsMonitor.java
(original)
+++ directory/shared/ldap/trunk/common/src/java/org/apache/ldap/common/util/OptionalComponentsMonitor.java
Tue Oct 25 04:43:56 2005
@@ -19,6 +19,12 @@
 package org.apache.ldap.common.util;
 
 
+/**
+ * A monitoring set where all elements are optional.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * @version $Rev$
+ */
 public class OptionalComponentsMonitor extends AbstractSimpleComponentsMonitor
 {
     public OptionalComponentsMonitor( String [] components )



Mime
View raw message