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:32:22 UTC
svn commit: r1772303 - in
/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model:
cursor/ entry/ exception/ filter/
Author: elecharny
Date: Fri Dec 2 05:32:22 2016
New Revision: 1772303
URL: http://svn.apache.org/viewvc?rev=1772303&view=rev
Log:
Added some missing Javadoc
Modified:
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/EmptyCursor.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/AbstractValue.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultAttribute.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultModification.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/ModificationOperation.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/Value.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ApproximateNode.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/EqualityNode.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/GreaterEqNode.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LessEqNode.java
directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/EmptyCursor.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/EmptyCursor.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/EmptyCursor.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/cursor/EmptyCursor.java Fri Dec 2 05:32:22 2016
@@ -43,6 +43,9 @@ public class EmptyCursor<E> extends Abst
private static final boolean IS_DEBUG = LOG_CURSOR.isDebugEnabled();
+ /**
+ * Creates a new EmptyCursor instance
+ */
public EmptyCursor()
{
if ( IS_DEBUG )
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/AbstractValue.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/AbstractValue.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/AbstractValue.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/AbstractValue.java Fri Dec 2 05:32:22 2016
@@ -36,7 +36,9 @@ import org.slf4j.LoggerFactory;
/**
* A wrapper around byte[] values in entries.
- *
+ *
+ * @param <T> The valye type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public abstract class AbstractValue<T> implements Value<T>
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultAttribute.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultAttribute.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultAttribute.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultAttribute.java Fri Dec 2 05:32:22 2016
@@ -570,7 +570,9 @@ public class DefaultAttribute implements
/**
- * {@inheritDoc}
+ * Sets the User Provided ID as a byte[]
+ *
+ * @param upId The User Provided ID
*/
public void setUpId( byte[] upId )
{
@@ -625,7 +627,10 @@ public class DefaultAttribute implements
/**
- * {@inheritDoc}
+ * Sets the User Provided ID as a byte[]
+ *
+ * @param upId The User Provided ID
+ * @param attributeType The asscoiated AttributeType
*/
public void setUpId( byte[] upId, AttributeType attributeType )
{
@@ -642,9 +647,6 @@ public class DefaultAttribute implements
}
- /**
- * {@inheritDoc}
- */
private void setUpIdInternal( String upId, String newId, AttributeType attributeType )
{
if ( attributeType == null )
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultModification.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultModification.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultModification.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/DefaultModification.java Fri Dec 2 05:32:22 2016
@@ -290,7 +290,7 @@ public class DefaultModification impleme
/**
- * {@inheritDoc}
+ * @return The associated AttributeType
*/
public AttributeType getAttributeType()
{
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/ModificationOperation.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/ModificationOperation.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/ModificationOperation.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/ModificationOperation.java Fri Dec 2 05:32:22 2016
@@ -29,8 +29,13 @@ package org.apache.directory.api.ldap.mo
*/
public enum ModificationOperation
{
+ /** Added attribute value */
ADD_ATTRIBUTE(0),
+
+ /** Removed attribute value */
REMOVE_ATTRIBUTE(1),
+
+ /** Replaced attribute value */
REPLACE_ATTRIBUTE(2);
/** Internal value */
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/Value.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/Value.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/Value.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/entry/Value.java Fri Dec 2 05:32:22 2016
@@ -31,12 +31,16 @@ import org.apache.directory.api.ldap.mod
* A interface for wrapping attribute values stored into an EntryAttribute. These
* values can be a String or a byte[].
*
+ * @param <T> The valye type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public interface Value<T> extends Cloneable, Externalizable, Comparable<Value<T>>
{
- /** Two flags used to tell if the value is HR or not in serialization */
+ /** A flag used to tell if the value is HR in serialization */
boolean STRING = true;
+
+ /** A flag used to tell if the value is not HR in serialization */
boolean BINARY = false;
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/AbstractLdapReferralException.java Fri Dec 2 05:32:22 2016
@@ -72,18 +72,33 @@ public class AbstractLdapReferralExcepti
}
+ /**
+ * Not yet implemented
+ *
+ * @return The Referral Context
+ * @throws NamingException If the operation failed
+ */
public Context getReferralContext() throws NamingException
{
throw new NotImplementedException();
}
+ /**
+ * Not yet implemented
+ * @param arg The arguments
+ * @return The referral context
+ * @throws NamingException If the operation failed
+ */
public Context getReferralContext( Map<?, ?> arg ) throws NamingException
{
throw new NotImplementedException();
}
+ /**
+ * Retry. Not yet implemented
+ */
public void retryReferral()
{
throw new NotImplementedException();
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ApproximateNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ApproximateNode.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ApproximateNode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/ApproximateNode.java Fri Dec 2 05:32:22 2016
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.mod
/**
* A simple assertion value node.
*
+ * @param <T> The Value type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ApproximateNode<T> extends SimpleNode<T>
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/EqualityNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/EqualityNode.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/EqualityNode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/EqualityNode.java Fri Dec 2 05:32:22 2016
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.mod
/**
* A assertion value node for Equality.
*
+ * @param <T> The Value type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class EqualityNode<T> extends SimpleNode<T>
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/GreaterEqNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/GreaterEqNode.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/GreaterEqNode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/GreaterEqNode.java Fri Dec 2 05:32:22 2016
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.mod
/**
* A assertion value node for GreaterOrEqual.
*
+ * @param <T> The Value type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class GreaterEqNode<T> extends SimpleNode<T>
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LessEqNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LessEqNode.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LessEqNode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/LessEqNode.java Fri Dec 2 05:32:22 2016
@@ -27,6 +27,8 @@ import org.apache.directory.api.ldap.mod
/**
* A assertion value node for LessOrEqual.
*
+ * @param <T> The Value type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class LessEqNode<T> extends SimpleNode<T>
Modified: directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java
URL: http://svn.apache.org/viewvc/directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java?rev=1772303&r1=1772302&r2=1772303&view=diff
==============================================================================
--- directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java (original)
+++ directory/shared/trunk/ldap/model/src/main/java/org/apache/directory/api/ldap/model/filter/SimpleNode.java Fri Dec 2 05:32:22 2016
@@ -29,6 +29,8 @@ import org.apache.directory.api.ldap.mod
/**
* A simple assertion value node.
*
+ * @param <T> The Value type
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public abstract class SimpleNode<T> extends LeafNode