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/09/01 22:15:18 UTC
svn commit: r1758864 - in
/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif:
LdifEntry.java LdifReader.java LdifUtils.java
anonymizer/AbstractAnonymizer.java anonymizer/Anonymizer.java
Author: elecharny
Date: Thu Sep 1 22:15:18 2016
New Revision: 1758864
URL: http://svn.apache.org/viewvc?rev=1758864&view=rev
Log:
Updated Javadocs
Modified:
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java
directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java?rev=1758864&r1=1758863&r2=1758864&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifEntry.java Thu Sep 1 22:15:18 2016
@@ -126,6 +126,8 @@ public class LdifEntry implements Clonea
/**
* Creates a new schema aware LdifEntry object.
+ *
+ * @param schemaManager The SchemaManager
*/
public LdifEntry( SchemaManager schemaManager )
{
@@ -141,6 +143,8 @@ public class LdifEntry implements Clonea
/**
* Creates a new LdifEntry object, storing an Entry
+ *
+ * @param entry The entry to encapsulate
*/
public LdifEntry( Entry entry )
{
@@ -300,7 +304,7 @@ public class LdifEntry implements Clonea
* Creates a LdifEntry using a list of strings representing the Ldif element
*
* @param dn The LdifEntry DN
- * @param avas The Ldif attributes and values to convert to an LdifEntry
+ * @param strings The Ldif attributes and values to convert to an LdifEntry
* @throws LdapInvalidDnException If the Dn is invalid
* @throws LdapInvalidAttributeValueException If either the AttributeType or the associated value
* is incorrect
@@ -562,7 +566,6 @@ public class LdifEntry implements Clonea
* Remove a list of Attributes from the LdifEntry
*
* @param ids The Attributes to remove
- * @return The list of removed EntryAttributes
*/
public void removeAttribute( String... ids )
{
@@ -937,6 +940,8 @@ public class LdifEntry implements Clonea
* the lengthBeforeParsing of the comments present in entry at the time of parsing
* so this lengthBeforeParsing may not always match with the lengthBeforeParsing of the entry
* data present in memory.
+ *
+ * @return The entry length, comments included
*/
public int getLengthBeforeParsing()
{
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java?rev=1758864&r1=1758863&r2=1758864&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifReader.java Thu Sep 1 22:15:18 2016
@@ -263,7 +263,9 @@ public class LdifReader implements Itera
/**
- * Constructors
+ * Creates a Schema aware reader
+ *
+ * @param schemaManager The SchemaManager
*/
public LdifReader( SchemaManager schemaManager )
{
@@ -2123,8 +2125,10 @@ public class LdifReader implements Itera
/**
- * creates a non-schemaaware LdifEntry
- * @return an LdifEntry that is not schemaaware
+ * Creates a schema aware LdifEntry
+ *
+ * @param schemaManager The SchemaManager
+ * @return an LdifEntry that is schema aware
*/
protected LdifEntry createLdifEntry( SchemaManager schemaManager )
{
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java?rev=1758864&r1=1758863&r2=1758864&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/LdifUtils.java Thu Sep 1 22:15:18 2016
@@ -115,7 +115,7 @@ public final class LdifUtils
* <li>13 (CR)</li>
* <li>32 (SPACE)</li>
* <li>58 (:)</li>
- * <li>60 (<)</li>
+ * <li>60 (<)</li>
* <li>Any character with value greater than 127</li>
* </ul>
*
@@ -555,7 +555,7 @@ public final class LdifUtils
/**
* Converts an EntryAttribute to LDIF
*
- * @param attr the >EntryAttribute to convert
+ * @param attr the EntryAttribute to convert
* @return the corresponding LDIF code as a String
* @throws LdapException If a naming exception is encountered.
*/
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java?rev=1758864&r1=1758863&r2=1758864&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/AbstractAnonymizer.java Thu Sep 1 22:15:18 2016
@@ -116,7 +116,7 @@ public abstract class AbstractAnonymizer
/**
- * @param latestValueMap The latest String anonymized value map
+ * @param latestStringMap The latest String anonymized value map
*/
@Override
public void setLatestStringMap( Map<Integer, String> latestStringMap )
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java?rev=1758864&r1=1758863&r2=1758864&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/ldif/anonymizer/Anonymizer.java Thu Sep 1 22:15:18 2016
@@ -70,7 +70,7 @@ public interface Anonymizer<K>
/**
- * @param latestValueMap The latest String anonymized value map
+ * @param latestStringMap The latest String anonymized value map
*/
void setLatestStringMap( Map<Integer, String> latestStringMap );