You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2016/12/02 05:24:28 UTC
svn commit: r1772302 - in
/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model:
csn/ ldif/ ldif/anonymizer/ message/ message/controls/ name/ password/
schema/ schema/comparators/ schema/normalizers/ schema/parsers/ schem...
Author: elecharny
Date: Fri Dec 2 05:24:28 2016
New Revision: 1772302
URL: http://svn.apache.org/viewvc?rev=1772302&view=rev
Log:
Added some missing Javadoc
Modified:
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifControl.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/BinaryAnonymizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/IntegerAnonymizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/AliasDerefMode.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/CompareResponse.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/IntermediateResponseImpl.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/MessageTypeEnum.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/ReferralsPolicyEnum.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/SearchScope.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/ChangeType.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/EntryChange.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearchImpl.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortRequestControlImpl.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResponseControlImpl.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResultCode.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Dn.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Rdn.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordDetails.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/AbstractSchemaObject.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimNormalizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimToLowerNormalizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDnNormalizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/csn/CsnFactory.java Fri Dec 2 05:24:28 2016
@@ -43,6 +43,10 @@ public class CsnFactory
private Object lock = new Object();
+ /**
+ * Creates a new CsnFactory instance
+ * @param replicaId The replica ID
+ */
public CsnFactory( int replicaId )
{
changeCount = 0;
@@ -111,6 +115,10 @@ public class CsnFactory
}
+ /**
+ * Sets the replica ID
+ * @param replicaId The replica ID
+ */
public void setReplicaId( int replicaId )
{
this.replicaId = replicaId;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifControl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifControl.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifControl.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifControl.java Fri Dec 2 05:24:28 2016
@@ -107,7 +107,9 @@ public class LdifControl implements Cont
/**
- * {@inheritDoc}
+ * Get back the control value
+ *
+ * @return The control's value
*/
public byte[] getValue()
{
@@ -116,7 +118,9 @@ public class LdifControl implements Cont
/**
- * {@inheritDoc}
+ * Store the control value
+ *
+ * @param value The value to store
*/
public void setValue( byte[] value )
{
@@ -125,7 +129,7 @@ public class LdifControl implements Cont
/**
- * {@inheritDoc}
+ * @return <t>TRUE</t> if the control has a value
*/
public boolean hasValue()
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java Fri Dec 2 05:24:28 2016
@@ -27,7 +27,9 @@ import java.util.Map;
import org.apache.directory.api.ldap.model.schema.SchemaManager;
/**
- * An abstract class implementing the default behavior of an Aninymizer instance
+ * An abstract class implementing the default behavior of an Anonymizer instance
+ *
+ * @param <K> The type of object being anonymized
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -116,7 +118,7 @@ public abstract class AbstractAnonymizer
/**
- * @param latestStringMap The latest String anonymized value map
+ * {@inheritDoc}
*/
@Override
public void setLatestStringMap( Map<Integer, String> latestStringMap )
@@ -136,7 +138,7 @@ public abstract class AbstractAnonymizer
/**
- * @param latestBytesMap The latest byte[] anonymized value map
+ * {@inheritDoc}
*/
@Override
public void setLatestBytesMap( Map<Integer, byte[]> latestBytesMap )
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java Fri Dec 2 05:24:28 2016
@@ -31,6 +31,8 @@ import org.apache.directory.api.ldap.mod
/**
* An interface for Anonymizers.
+ *
+ * @param <K> The type of object that will be anonymized
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/BinaryAnonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/BinaryAnonymizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/BinaryAnonymizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/BinaryAnonymizer.java Fri Dec 2 05:24:28 2016
@@ -111,7 +111,8 @@ public class BinaryAnonymizer extends Ab
/**
* {@inheritDoc}
*/
- public void setLatestBytesgMap( Map<Integer, byte[]> latestBytesMap )
+ @Override
+ public void setLatestBytesMap( Map<Integer, byte[]> latestBytesMap )
{
this.latestBytesMap = latestBytesMap;
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/IntegerAnonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/IntegerAnonymizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/IntegerAnonymizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/IntegerAnonymizer.java Fri Dec 2 05:24:28 2016
@@ -117,9 +117,9 @@ public class IntegerAnonymizer extends A
return result;
}
-
+
/**
- * {@inheritDoc}
+ * @return The Map containing the latest anonymized value for each integer
*/
public Map<Integer, String> getLatestIntegerMap()
{
@@ -128,7 +128,8 @@ public class IntegerAnonymizer extends A
/**
- * {@inheritDoc}
+ * Set the Map containing anonymized integers
+ * @param latestIntegerMap The Map containing the latest anonymized value for each integer
*/
public void setLatestIntegerMap( Map<Integer, String> latestIntegerMap )
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/AliasDerefMode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/AliasDerefMode.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/AliasDerefMode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/AliasDerefMode.java Fri Dec 2 05:24:28 2016
@@ -231,7 +231,7 @@ public enum AliasDerefMode
/**
- * get the AliasDerefMode corresponding to the string value {@link #jndiValue} passed
+ * get the AliasDerefMode corresponding to the string value jndiValue passed
*
* @param val the AliasDerefMode's string value
* @return the AliasDerefMode whose value is equivalent to the given string value
@@ -265,6 +265,9 @@ public enum AliasDerefMode
}
+ /**
+ * @return The JNDI value
+ */
public String getJndiValue()
{
return jndiValue;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/CompareResponse.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/CompareResponse.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/CompareResponse.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/CompareResponse.java Fri Dec 2 05:24:28 2016
@@ -29,7 +29,6 @@ package org.apache.directory.api.ldap.mo
public interface CompareResponse extends ResultResponse
{
/**
- * @return True if the compared response is a success
* @return <tt>true</tt> if the compare response is TRUE, <tt>false</tt> otherwise
*/
boolean isTrue();
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/IntermediateResponseImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/IntermediateResponseImpl.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/IntermediateResponseImpl.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/IntermediateResponseImpl.java Fri Dec 2 05:24:28 2016
@@ -41,6 +41,10 @@ public class IntermediateResponseImpl ex
protected byte[] responseValue;
+ /**
+ * Creates a new IntermediateResponseImpl instance
+ * @param id The request ID
+ */
public IntermediateResponseImpl( int id )
{
super( id, TYPE );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/MessageTypeEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/MessageTypeEnum.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/MessageTypeEnum.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/MessageTypeEnum.java Fri Dec 2 05:24:28 2016
@@ -27,25 +27,66 @@ package org.apache.directory.api.ldap.mo
*/
public enum MessageTypeEnum
{
+ /** The AbandonRequest message */
ABANDON_REQUEST,
+
+ /** The AddResquest message */
ADD_REQUEST,
+
+ /** The Response message */
ADD_RESPONSE,
+
+ /** The BindRequest message */
BIND_REQUEST,
+
+ /** The BindResponse message */
BIND_RESPONSE,
+
+ /** The ompareRequest message */
COMPARE_REQUEST,
+
+ /** The CompareResponse message */
COMPARE_RESPONSE,
+
+ /** The DelRequest message */
DEL_REQUEST,
+
+ /** The DelResponse message */
DEL_RESPONSE,
+
+ /** The ExtendedRequest message */
EXTENDED_REQUEST,
+
+ /** The ExtendedResponse message */
EXTENDED_RESPONSE,
+
+ /** The ModifyDNRequest message */
MODIFYDN_REQUEST,
+
+ /** The ModifyDNResponse message */
MODIFYDN_RESPONSE,
+
+ /** The ModifyRequest message */
MODIFY_REQUEST,
+
+ /** The ModifyResponse message */
MODIFY_RESPONSE,
+
+ /** The SearchRequest message */
SEARCH_REQUEST,
+
+ /** The SeaechResultDone response message */
SEARCH_RESULT_DONE,
+
+ /** The SearchResultEntry Response message */
SEARCH_RESULT_ENTRY,
+
+ /** The earchResultReference Response message */
SEARCH_RESULT_REFERENCE,
+
+ /** The UnbindRequest message */
UNBIND_REQUEST,
+
+ /** The IntermediateResponse message */
INTERMEDIATE_RESPONSE;
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/ReferralsPolicyEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/ReferralsPolicyEnum.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/ReferralsPolicyEnum.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/ReferralsPolicyEnum.java Fri Dec 2 05:24:28 2016
@@ -30,7 +30,12 @@ package org.apache.directory.api.ldap.mo
*/
public enum ReferralsPolicyEnum
{
+ /** Ignore referral */
IGNORE,
+
+ /** Floow referral */
FOLLOW,
+
+ /** Throw an exception */
THROW
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/SearchScope.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/SearchScope.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/SearchScope.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/SearchScope.java Fri Dec 2 05:24:28 2016
@@ -30,8 +30,13 @@ import org.apache.directory.api.i18n.I18
*/
public enum SearchScope
{
+ /** Base scope */
OBJECT(0, "base"),
+
+ /** One Level scope */
ONELEVEL(1, "one"),
+
+ /** Subtree scope */
SUBTREE(2, "sub");
/**
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/ChangeType.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/ChangeType.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/ChangeType.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/ChangeType.java Fri Dec 2 05:24:28 2016
@@ -42,12 +42,16 @@ import org.apache.directory.api.i18n.I18
*/
public enum ChangeType
{
+ /** An ADD */
ADD(1),
+ /** A Delete */
DELETE(2),
+ /** A Modify */
MODIFY(4),
+ /** A MODDN */
MODDN(8);
private int value;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/EntryChange.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/EntryChange.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/EntryChange.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/EntryChange.java Fri Dec 2 05:24:28 2016
@@ -73,6 +73,7 @@ import org.apache.directory.api.ldap.mod
*/
public interface EntryChange extends Control
{
+ /** No defined change number */
int UNDEFINED_CHANGE_NUMBER = -1;
/** The EntryChange control */
@@ -93,14 +94,30 @@ public interface EntryChange extends Con
void setChangeType( ChangeType changeType );
+ /**
+ * @return The previous DN
+ */
Dn getPreviousDn();
+ /**
+ * Sets the previous DN
+ *
+ * @param previousDn The previous DN
+ */
void setPreviousDn( Dn previousDn );
+ /**
+ * @return The change number
+ */
long getChangeNumber();
+ /**
+ * Sets the ChangeNumber
+ *
+ * @param changeNumber The ChanegNumber
+ */
void setChangeNumber( long changeNumber );
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearch.java Fri Dec 2 05:24:28 2016
@@ -35,32 +35,75 @@ public interface PersistentSearch extend
/** Min and Max values for the possible combined change types */
int CHANGE_TYPES_MIN = ChangeType.ADD.getValue();
+ /** The maximum value for the possible combined changes type */
int CHANGE_TYPES_MAX = ChangeType.ADD.getValue()
| ChangeType.DELETE.getValue()
| ChangeType.MODIFY.getValue()
| ChangeType.MODDN.getValue();
+ /**
+ * Sets the ChangesOnly flag
+ *
+ * @param changesOnly The ChangesOnly flag
+ */
void setChangesOnly( boolean changesOnly );
+ /**
+ * @return <T>TRUE</T> if the changesOnly flag is set
+ */
boolean isChangesOnly();
+ /**
+ * Sets the return entry changes flag
+ *
+ * @param returnECs the return entry changes flag
+ */
void setReturnECs( boolean returnECs );
+ /**
+ * @return <T>TRUE</T> if the return entry changes flag is set
+ */
boolean isReturnECs();
+ /**
+ * Set the changeType value we want to get back ( a combinaison of Add, Delete,
+ * Modify and ModifyDN)
+ *
+ * @param changeTypes The changeType values (Add, Modify, Delete and ModifyDn)
+ */
void setChangeTypes( int changeTypes );
+ /**
+ * @return The changeTypes value
+ */
int getChangeTypes();
+ /**
+ * For each changeType, tells if the notification is enabled
+ *
+ * @param changeType The ChnageType we are interested in
+ * @return <T>TRUE<T> if the notification is set for this ChangeType
+ */
boolean isNotificationEnabled( ChangeType changeType );
+ /**
+ * Sets the notification for a given changeType
+ * @param changeType The chnageType we want some notification to be set
+ */
void enableNotification( ChangeType changeType );
+
+
+ /**
+ * Unsets the notification for a given changeType
+ * @param changeType The chnageType we want some notification to be unset
+ */
+ void disableNotification( ChangeType changeType );
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearchImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearchImpl.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearchImpl.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/PersistentSearchImpl.java Fri Dec 2 05:24:28 2016
@@ -64,6 +64,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void setChangesOnly( boolean changesOnly )
{
@@ -71,6 +74,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean isChangesOnly()
{
@@ -78,6 +84,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void setReturnECs( boolean returnECs )
{
@@ -85,6 +94,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean isReturnECs()
{
@@ -92,6 +104,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void setChangeTypes( int changeTypes )
{
@@ -99,6 +114,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public int getChangeTypes()
{
@@ -106,6 +124,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public boolean isNotificationEnabled( ChangeType changeType )
{
@@ -113,6 +134,9 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void enableNotification( ChangeType changeType )
{
@@ -120,6 +144,16 @@ public class PersistentSearchImpl extend
}
+ /**
+ * {@inheritDoc}
+ */
+ @Override
+ public void disableNotification( ChangeType changeType )
+ {
+ changeTypes &= ~changeType.getValue();
+ }
+
+
/**
* Return a String representing this PSearchControl.
*/
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortRequestControlImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortRequestControlImpl.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortRequestControlImpl.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortRequestControlImpl.java Fri Dec 2 05:24:28 2016
@@ -37,6 +37,9 @@ public class SortRequestControlImpl exte
private List<SortKey> sortKeys;
+ /**
+ * Creates a new SortRequestControlImpl instance
+ */
public SortRequestControlImpl()
{
super( OID );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResponseControlImpl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResponseControlImpl.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResponseControlImpl.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResponseControlImpl.java Fri Dec 2 05:24:28 2016
@@ -32,6 +32,9 @@ public class SortResponseControlImpl ext
/** name of the first offending attribute */
private String attributeName;
+ /**
+ * Creates a new SortResponseControlImpl instance
+ */
public SortResponseControlImpl()
{
super( OID );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResultCode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResultCode.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResultCode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/message/controls/SortResultCode.java Fri Dec 2 05:24:28 2016
@@ -58,6 +58,9 @@ public enum SortResultCode
this.desc = desc;
}
+ /**
+ * @return The internet value
+ */
public int getVal()
{
return val;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Ava.java Fri Dec 2 05:24:28 2016
@@ -1173,7 +1173,6 @@ public class Ava implements Externalizab
/**
* @see Comparable#compareTo(Object)
*/
- @SuppressWarnings("unchecked")
@Override
public int compareTo( Ava that )
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Dn.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Dn.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Dn.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Dn.java Fri Dec 2 05:24:28 2016
@@ -902,7 +902,13 @@ public class Dn implements Iterable<Rdn>
/**
- * {@inheritDoc}
+ * Add a suffix to the Dn. For instance, if the current Dn is "ou=people",
+ * and the suffix "dc=example,dc=com", then the resulting Dn will be
+ * "ou=people,dc=example,dc=com"
+ *
+ * @param suffix the suffix to add
+ * @return The resulting Dn with the additional suffix
+ * @throws LdapInvalidDnException If the resulting Dn is not valid
*/
public Dn add( Dn suffix ) throws LdapInvalidDnException
{
@@ -937,7 +943,13 @@ public class Dn implements Iterable<Rdn>
/**
- * {@inheritDoc}
+ * Add a suffix to the Dn. For instance, if the current Dn is "ou=people",
+ * and the suffix "dc=example,dc=com", then the resulting Dn will be
+ * "ou=people,dc=example,dc=com"
+ *
+ * @param comp the suffix to add
+ * @return The resulting Dn with the additional suffix
+ * @throws LdapInvalidDnException If the resulting Dn is not valid
*/
public Dn add( String comp ) throws LdapInvalidDnException
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Rdn.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Rdn.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Rdn.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/name/Rdn.java Fri Dec 2 05:24:28 2016
@@ -329,6 +329,13 @@ public class Rdn implements Cloneable, E
}
+ /**
+ * A constructor that constructs a Schema aware Rdn from some values.
+ *
+ * @param schemaManager The schemaManager to use
+ * @param avas The list of values
+ * @throws LdapInvalidDnException If the Rdn is invalid
+ */
public Rdn( SchemaManager schemaManager, Ava... avas ) throws LdapInvalidDnException
{
StringBuilder buffer = new StringBuilder();
@@ -349,6 +356,12 @@ public class Rdn implements Cloneable, E
}
+ /**
+ * A constructor that constructs a Rdn from some values.
+ *
+ * @param avas The list of values
+ * @throws LdapInvalidDnException If the Rdn is invalid
+ */
public Rdn( Ava... avas ) throws LdapInvalidDnException
{
this( null, avas );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordDetails.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordDetails.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordDetails.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/password/PasswordDetails.java Fri Dec 2 05:24:28 2016
@@ -28,9 +28,11 @@ import org.apache.directory.api.ldap.mod
* A class to store all informations about an password.
*
* This includes:
- * - the used algorithm
- * - the salt if any
- * - the password itself.
+ * <ul>
+ * <li> the used algorithm</li>
+ * <li> the salt if any</li>
+ * <li> the password itself</li>
+ * </ul>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -41,6 +43,13 @@ public class PasswordDetails
private final byte[] password;
+ /**
+ * Creates a new PasswordDetails instance
+ *
+ * @param algorithm The algorithm to use
+ * @param salt The Salt to use
+ * @param password The password
+ */
public PasswordDetails( LdapSecurityConstants algorithm, byte[] salt, byte[] password )
{
this.algorithm = algorithm;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/AbstractSchemaObject.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/AbstractSchemaObject.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/AbstractSchemaObject.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/AbstractSchemaObject.java Fri Dec 2 05:24:28 2016
@@ -942,6 +942,9 @@ public boolean hasExtension( String exte
}
+ /**
+ * Unlock the Schema Object and make it modifiable again.
+ */
public void unlock()
{
locked = false;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java Fri Dec 2 05:24:28 2016
@@ -28,6 +28,8 @@ import java.util.Comparator;
* An class used for Comparator. It inherits from the general AbstractAdsSchemaObject class. It
* also implements the Comparator interface
*
+ * @param <T> The comparator type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public abstract class LdapComparator<T> extends LoadableSchemaObject implements Comparator<T>, Serializable
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java Fri Dec 2 05:24:28 2016
@@ -38,9 +38,17 @@ import java.util.Map;
* these server side objects that generate these mappings. Instead when a
* resolver is used we can create mock or almost right implementations.
*
+ * @param <E> The normalizer type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public interface NormalizerMappingResolver<E extends Normalizer>
{
+ /**
+ * Gets the Map containing the normalizers associated to an OID or name
+ *
+ * @return The normalizer Map
+ * @throws Exception If not found
+ */
Map<String, E> getNormalizerMapping() throws Exception;
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java Fri Dec 2 05:24:28 2016
@@ -158,15 +158,34 @@ public final class PrepareString
*/
public enum StringType
{
+ /** Not a String */
NOT_STRING,
+
+ /** A numeric String */
NUMERIC_STRING,
+
+ /** Case sensitive String */
CASE_EXACT,
+
+ /** IA5 case sensitive String */
CASE_EXACT_IA5,
+
+ /** IA5 case insensitive String */
CASE_IGNORE_IA5,
+
+ /** Case insensitive String list */
CASE_IGNORE_LIST,
+
+ /** Case insensitive String */
CASE_IGNORE,
+
+ /** Directory String */
DIRECTORY_STRING,
+
+ /** Telephone number String */
TELEPHONE_NUMBER,
+
+ /** A word */
WORD
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java Fri Dec 2 05:24:28 2016
@@ -30,16 +30,37 @@ import org.apache.directory.api.ldap.mod
*/
public enum SchemaObjectType
{
+ /** An AttributeType */
ATTRIBUTE_TYPE(0),
+
+ /** A Comparator */
COMPARATOR(1),
+
+ /** */
DIT_CONTENT_RULE(2),
+
+ /** */
DIT_STRUCTURE_RULE(3),
+
+ /** A Syntax */
LDAP_SYNTAX(4),
+
+ /** A MatchingRule */
MATCHING_RULE(5),
+
+ /** A MatchingRuleUse */
MATCHING_RULE_USE(6),
+
+ /** A NameForm */
NAME_FORM(7),
+
+ /** A Normalizer */
NORMALIZER(8),
+
+ /** An ObjectClass */
OBJECT_CLASS(9),
+
+ /** A SyntaxChecker */
SYNTAX_CHECKER(10);
/** The inner value*/
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java Fri Dec 2 05:24:28 2016
@@ -28,6 +28,8 @@ import org.apache.directory.api.util.Str
* A comparator that compares the objectClass type with values: AUXILIARY,
* ABSTRACT, and STRUCTURAL.
*
+ * @param <T> The type of object to compare
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ObjectClassTypeComparator<T> extends LdapComparator<T>
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java Fri Dec 2 05:24:28 2016
@@ -33,6 +33,8 @@ import org.apache.directory.api.ldap.mod
* A serializable wrapper around a Comparator which uses delayed initialization
* of the underlying wrapped comparator which is JIT resolved from a static
* global registry.
+ *
+ * @param <E> The type of object to compare
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java Fri Dec 2 05:24:28 2016
@@ -40,6 +40,7 @@ public class UuidComparator extends Seri
private static final Logger LOG = LoggerFactory.getLogger( UuidComparator.class );
private static final boolean IS_DEBUG = LOG.isDebugEnabled();
+ /** A static instance of the UuidComparator */
public static final UuidComparator INSTANCE = new UuidComparator( "1.3.6.1.1.16.4" );
@@ -84,7 +85,12 @@ public class UuidComparator extends Seri
/**
- * {@inheritDoc}
+ * Compare two UUID.
+ *
+ * @param uuid1 The first UUID
+ * @param uuid2 he second UUID
+ * @return -1 if the first UUID is lower than the second UUID, 1 if it's higher, 0
+ * if they are equal
*/
public int compare( UUID uuid1, UUID uuid2 )
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimNormalizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimNormalizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimNormalizer.java Fri Dec 2 05:24:28 2016
@@ -32,6 +32,9 @@ package org.apache.directory.api.ldap.mo
@SuppressWarnings("serial")
public class CachingDeepTrimNormalizer extends CachingNormalizer
{
+ /**
+ * Creates a new CachingDeepTrimNormalizer instance
+ */
public CachingDeepTrimNormalizer()
{
super( new DeepTrimNormalizer() );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimToLowerNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimToLowerNormalizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimToLowerNormalizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDeepTrimToLowerNormalizer.java Fri Dec 2 05:24:28 2016
@@ -32,6 +32,9 @@ package org.apache.directory.api.ldap.mo
@SuppressWarnings("serial")
public class CachingDeepTrimToLowerNormalizer extends CachingNormalizer
{
+ /**
+ * Creates a new CachingDeepTrimToLowerNormalizer instance
+ */
public CachingDeepTrimToLowerNormalizer()
{
super( new DeepTrimToLowerNormalizer() );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDnNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDnNormalizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDnNormalizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/CachingDnNormalizer.java Fri Dec 2 05:24:28 2016
@@ -35,6 +35,9 @@ import org.apache.directory.api.ldap.mod
@SuppressWarnings("serial")
public class CachingDnNormalizer extends CachingNormalizer
{
+ /**
+ * Creates a new CachingDnNormalizer instance
+ */
public CachingDnNormalizer()
{
super( new DnNormalizer() );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java Fri Dec 2 05:24:28 2016
@@ -43,6 +43,9 @@ public class UniqueMemberNormalizer exte
private SchemaManager schemaManager;
+ /**
+ * Creates a new UniqueMemberNormalizer instance
+ */
public UniqueMemberNormalizer()
{
super( SchemaConstants.UNIQUE_MEMBER_MATCH_MR_OID );
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java Fri Dec 2 05:24:28 2016
@@ -38,6 +38,8 @@ import antlr.TokenStreamRecognitionExcep
/**
* Base class of all schema parsers.
+ *
+ * @param <T> The type of SchemaObject
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java Fri Dec 2 05:24:28 2016
@@ -28,9 +28,13 @@ package org.apache.directory.api.ldap.mo
*/
public class ConsoleParserMonitor implements ParserMonitor
{
+ /** The maven property to add on the commmand line */
public static final String TRACE_KEY = "maven.eve.schema.parser.trace";
+ /**
+ * {@inheritDoc}
+ */
@Override
public void matchedProduction( String prod )
{
@@ -41,6 +45,9 @@ public class ConsoleParserMonitor implem
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void startedParse( String s )
{
@@ -51,6 +58,9 @@ public class ConsoleParserMonitor implem
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public void finishedParse( String s )
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java Fri Dec 2 05:24:28 2016
@@ -39,6 +39,8 @@ import org.slf4j.LoggerFactory;
/**
* Common schema object registry interface.
+ *
+ * @param <T> The type of SchemaObject
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@@ -418,7 +420,10 @@ public abstract class DefaultSchemaObjec
/**
- * {@inheritDoc}
+ * Copy a SchemaObject registry
+ *
+ * @param original The SchemaObject registry to copy
+ * @return The copied ShcemaObject registry
*/
// This will suppress PMD.EmptyCatchBlock warnings in this method
@SuppressWarnings("unchecked")
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java Fri Dec 2 05:24:28 2016
@@ -38,7 +38,8 @@ import org.slf4j.LoggerFactory;
/**
* Object identifier registry. It stores the OIDs for AT, OC, MR, LS, MRU, DSR, DCR and NF.
* An OID is unique, and associated with a SO.
- *
+ *
+ * @param <T> The type of SchemaObject
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class OidRegistry<T extends SchemaObject> implements Iterable<T>
@@ -329,6 +330,9 @@ public class OidRegistry<T extends Schem
}
+ /**
+ * Empty the byOid map
+ */
public void clear()
{
// remove all the OID
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java Fri Dec 2 05:24:28 2016
@@ -127,8 +127,11 @@ public class Registries implements Schem
/** A flag indicating that disabled SchemaObject are accepted */
private boolean disabledAccepted;
- /** Two flags for RELAXED and STRUCT */
+ /** Two flags for RELAXED and STRiCT */
+ /** The strict mode */
public static final boolean STRICT = false;
+
+ /** The relaxed mode */
public static final boolean RELAXED = true;
/**
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java Fri Dec 2 05:24:28 2016
@@ -32,6 +32,11 @@ public class NotRefinement implements Re
private Refinement refinement;
+ /**
+ * Creates a new NotRefinement instance
+ *
+ * @param refinement The filter
+ */
public NotRefinement( Refinement refinement )
{
this.refinement = refinement;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java Fri Dec 2 05:24:28 2016
@@ -34,8 +34,15 @@ package org.apache.directory.api.ldap.mo
*/
public enum HostTypeEnum
{
+ /** IP V4 host */
IPV4,
+
+ /** IP V6 host */
IPV6,
+
+ /** IP V(future) host */
IPV_FUTURE,
+
+ /** Regular name host */
REGULAR_NAME
}
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java?rev=1772302&r1=1772301&r2=1772302&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java Fri Dec 2 05:24:28 2016
@@ -213,6 +213,7 @@ public class LdapUrl
// The scheme
pos = Strings.areEquals( chars, 0, LDAP_SCHEME );
+
if ( pos == StringConstants.NOT_EQUAL )
{
pos = Strings.areEquals( chars, 0, LDAPS_SCHEME );
@@ -1720,7 +1721,6 @@ public class LdapUrl
* Get a string representation of a LdapUrl.
*
* @return A LdapUrl string
- * @see LdapUrl#forceScopeRendering
*/
@Override
public String toString()