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/17 15:18:17 UTC
svn commit: r1774774 [10/10] - in /directory/shared/branches/shared-value:
./ asn1/ber/src/main/java/org/apache/directory/api/asn1/actions/
asn1/ber/src/main/java/org/apache/directory/api/asn1/ber/
asn1/ber/src/main/java/org/apache/directory/api/asn1/b...
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/LdapComparator.java Sat Dec 17 15:18:15 2016
@@ -30,6 +30,8 @@ import org.apache.directory.api.ldap.mod
* 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/MatchingRuleTypeEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/MatchingRuleTypeEnum.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/MatchingRuleTypeEnum.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/MatchingRuleTypeEnum.java Sat Dec 17 15:18:15 2016
@@ -28,27 +28,60 @@ package org.apache.directory.api.ldap.mo
public enum MatchingRuleTypeEnum
{
// The EQUALITY matching rules
+ /** Case Exact Match */
CASE_EXACT_MATCH( "2.5.13.5" ),
+
+ /** Case Exact IA5 Match */
CASE_EXACT_IA5_MATCH( "1.3.6.1.4.1.1466.109.114.1" ),
+
+ /** Case Ignore Match */
CASE_IGNORE_IA5_MATCH( "1.3.6.1.4.1.1466.109.114.2" ),
+
+ /** Case Ignore List Match */
CASE_IGNORE_LIST_MATCH( "2.5.13.11" ),
+
+ /** Case Ignore Match */
CASE_IGNORE_MATCH( "2.5.13.2" ),
+
+ /** DirectoryString First Component Match */
DIRECTORY_STRING_FIRST_COMPONENT_MATCH( "2.5.13.31" ),
+
+ /** Numeric String Match */
NUMERIC_STRING_MATCH( "2.5.13.8" ),
+
+ /** Telephone Number Match */
TELEPHONE_NUMBER_MATCH( "2.5.13.20" ),
+
+ /** Word Match */
WORD_MATCH( "2.5.13.32" ),
// The ORDERING matching rules
+ /** Case Exact Ordering Match */
CASE_EXACT_ORDERING_MATCH( "2.5.13.6" ),
+
+ /** Case Ignore Ordering Match */
CASE_IGNORE_ORDERING_MATCH( "2.5.13.3" ),
+
+ /** Numeric String Ordering Match */
NUMERIC_STRING_ORDERING_MATCH( "2.5.13.9" ),
// The SUBSTRING matching rules
+ /** Case Exact Substring Match */
CASE_EXACT_SUBSTRINGS_MATCH( "2.5.13.7" ),
+
+ /** Case Ignore IA5 Substring Match */
CASE_IGNORE_IA5_SUBSTRINGS_MATCH( "1.3.6.1.4.1.1466.109.114.3" ),
+
+ /** Case Ignore List Substring Match */
CASE_IGNORE_LIST_SUBSTRINGS_MATCH( "2.5.13.12" ),
+
+ /** CaseIgnore Substring Match */
CASE_IGNORE_SUBSTRINGS_MATCH( "2.5.13.4" ),
+
+ /** Numeric String Substring Match */
NUMERIC_STRING_SUBSTRINGS_MATCH( "2.5.13.10" ),
+
+ /** Telephone Number Substring Match */
TELEPHONE_NUMBER_SUBSTRINGS_MATCH( "2.5.13.21" );
/** The interned MR OID */
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/NormalizerMappingResolver.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/PrepareString.java Sat Dec 17 15:18:15 2016
@@ -56,10 +56,17 @@ public final class PrepareString
*/
public enum AssertionType
{
- SUBSTRING_INITIAL, // The INITIAL part of a substring assertion value
- SUBSTRING_ANY, // The ANY part of a substring assertion value
- SUBSTRING_FINAL, // The FINAL part of a substring assertion value
- ATTRIBUTE_VALUE // An Attribute Value
+ /** The INITIAL part of a substring assertion value */
+ SUBSTRING_INITIAL,
+
+ /** The ANY part of a substring assertion value */
+ SUBSTRING_ANY,
+
+ /** The FINAL part of a substring assertion value */
+ SUBSTRING_FINAL,
+
+ /** An Attribute Value */
+ ATTRIBUTE_VALUE
}
/** An exception used to get out of the map method quickly */
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/SchemaObjectType.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/DnComparator.java Sat Dec 17 15:18:15 2016
@@ -53,7 +53,12 @@ public class DnComparator extends LdapCo
/**
- * {@inheritDoc}
+ * Compare two String DNs
+ *
+ * @param dn1 The first DN
+ * @param dn2 The second DN
+ *
+ * @return -1 i the first DN is inferior to the second DN, 1 if the second DN is superior, 0 of they are equal
*/
public int compare( String dn1, String dn2 )
{
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/ObjectClassTypeComparator.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/SerializableComparator.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UniqueMemberComparator.java Sat Dec 17 15:18:15 2016
@@ -168,6 +168,13 @@ public class UniqueMemberComparator exte
}
+ /**
+ * Get the DN from the given object
+ *
+ * @param obj The object containing a DN (either as an instance of Dn or as a String)
+ * @return A Dn instance
+ * @throws LdapInvalidDnException If the Dn is invalid
+ */
public Dn getDn( Object obj ) throws LdapInvalidDnException
{
Dn dn;
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/comparators/UuidComparator.java Sat Dec 17 15:18:15 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" );
@@ -79,7 +80,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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/NumericNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/NumericNormalizer.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/NumericNormalizer.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/NumericNormalizer.java Sat Dec 17 15:18:15 2016
@@ -46,7 +46,11 @@ public class NumericNormalizer extends N
/**
- * {@inheritDoc}
+ * Normalize a Value
+ *
+ * @param value The value to normalize
+ * @return The normalized value
+ * @exception LdapException If teh value cannot be normalized or is invalid
*/
public Value normalize( Value value ) throws LdapException
{
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/normalizers/UniqueMemberNormalizer.java Sat Dec 17 15:18:15 2016
@@ -42,6 +42,9 @@ public class UniqueMemberNormalizer exte
private transient SchemaManager schemaManager;
+ /**
+ * Creates a new UniqueMemberNormalizer instance
+ */
public UniqueMemberNormalizer()
{
super( SchemaConstants.UNIQUE_MEMBER_MATCH_MR_OID );
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/AbstractSchemaParser.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/parsers/ConsoleParserMonitor.java Sat Dec 17 15:18:15 2016
@@ -28,6 +28,7 @@ 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";
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/DefaultSchemaObjectRegistry.java Sat Dec 17 15:18:15 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 String getOidByName( String name
/**
- * {@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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/OidRegistry.java Sat Dec 17 15:18:15 2016
@@ -38,6 +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>
*/
@@ -329,6 +331,9 @@ public class OidRegistry<T extends Schem
}
+ /**
+ * Empty the byOid map
+ */
public void clear()
{
// remove all the OID
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/schema/registries/Registries.java Sat Dec 17 15:18:15 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 modes */
+ /** The strict mode */
public static final boolean STRICT = false;
+
+ /** The relaxed mode */
public static final boolean RELAXED = true;
/**
Modified: directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/subtree/NotRefinement.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/HostTypeEnum.java Sat Dec 17 15:18:15 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/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java (original)
+++ directory/shared/branches/shared-value/ldap/model/src/main/java/org/apache/directory/api/ldap/model/url/LdapUrl.java Sat Dec 17 15:18:15 2016
@@ -1717,7 +1717,6 @@ public class LdapUrl
* Get a string representation of a LdapUrl.
*
* @return A LdapUrl string
- * @see LdapUrl#forceScopeRendering
*/
@Override
public String toString()
Modified: directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java (original)
+++ directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/loader/EntityFactory.java Sat Dec 17 15:18:15 2016
@@ -37,6 +37,12 @@ import org.apache.directory.api.ldap.mod
import org.apache.directory.api.ldap.model.schema.registries.Schema;
+/**
+ * An interface to be implemented by classes needed to create Schema elements. The factory
+ * will creates schema elements based on an Entry.
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ */
public interface EntityFactory
{
/**
Modified: directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java (original)
+++ directory/shared/branches/shared-value/ldap/schema/data/src/main/java/org/apache/directory/api/ldap/schema/manager/impl/DefaultSchemaManager.java Sat Dec 17 15:18:15 2016
@@ -629,7 +629,9 @@ public class DefaultSchemaManager implem
/**
- * {@inheritDoc}
+ * Currently not implemented.
+ *
+ * @return Always FALSE
*/
public boolean isDisabledAccepted()
{
Added: directory/shared/branches/shared-value/mvnsonar.sh
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/mvnsonar.sh?rev=1774774&view=auto
==============================================================================
--- directory/shared/branches/shared-value/mvnsonar.sh (added)
+++ directory/shared/branches/shared-value/mvnsonar.sh Sat Dec 17 15:18:15 2016
@@ -0,0 +1 @@
+mvn clean install sonar:sonar -Dsonar.host.url=https://nemo.sonarqube.org -Dsonar.login=48ccde7aead887e149ff3a72c9bae51cdaf2fee4
Propchange: directory/shared/branches/shared-value/mvnsonar.sh
------------------------------------------------------------------------------
svn:executable = *
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/EmptyEnumeration.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/EmptyEnumeration.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/EmptyEnumeration.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/EmptyEnumeration.java Sat Dec 17 15:18:15 2016
@@ -31,11 +31,12 @@ import javax.naming.NamingEnumeration;
* hasMore/hasMoreElements() always returns false, and next/nextElement() always
* throws a NoSuchElementException.
*
+ * @param <T> The element in the enumeration
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
-public class EmptyEnumeration<T> implements NamingEnumeration<T>
+public class EmptyEnumeration<T> implements NamingEnumeration<Object>
{
-
/**
* @see javax.naming.NamingEnumeration#close()
*/
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/ExpansibleByteBuffer.java Sat Dec 17 15:18:15 2016
@@ -43,12 +43,20 @@ public class ExpansibleByteBuffer
private byte[] buf;
+ /**
+ * Create a default ExpansibleByteBuffer capable of holding 10 bytes
+ */
public ExpansibleByteBuffer()
{
this( DEFAULT_INITIAL_SIZE );
}
+ /**
+ * Creates a ExpansibleByteBuffer which has an initialze size
+ *
+ * @param initialSize The initial buffer size
+ */
public ExpansibleByteBuffer( int initialSize )
{
if ( initialSize <= 0 )
@@ -61,6 +69,11 @@ public class ExpansibleByteBuffer
}
+ /**
+ * Reset the Buffer position to 0. Every new added byte will be put on position 0.
+ * Note that whatever this buffer contained before a call to the clear() method
+ * will not be removed.
+ */
public final void clear()
{
pos = 0;
@@ -87,12 +100,22 @@ public class ExpansibleByteBuffer
}
+ /**
+ * @return The number of bytes that can be added into this buffer
+ */
public final int capacity()
{
return buf.length;
}
+ /**
+ * Returns the byte at a given position. Note that no control is done
+ * on the position validity.
+ *
+ * @param i The position
+ * @return The byte at the given position in the buffer
+ */
public final byte get( int i )
{
return buf[i];
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/FileUtils.java Sat Dec 17 15:18:15 2016
@@ -579,7 +579,6 @@ public final class FileUtils
* @throws IOException if source or destination is invalid
* @throws IOException if an IO error occurs during copying
* @throws IOException if the output file length is not the same as the input file length after the copy completes
- * @see #doCopyFile(File, File, boolean)
*/
public static void copyFile( File srcFile, File destFile, boolean preserveFileDate ) throws IOException
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/IOUtils.java Sat Dec 17 15:18:15 2016
@@ -359,7 +359,7 @@ public final class IOUtils
* This method buffers the input internally, so there is no need to use a
* <code>BufferedReader</code>.
* <p>
- * The buffer size is given by {@link #DEFAULT_BUFFER_SIZE}.
+ * The buffer size is given by #DEFAULT_BUFFER_SIZE.
*
* @param input the <code>Reader</code> to read from
* @param output the <code>Writer</code> to write to
@@ -381,7 +381,7 @@ public final class IOUtils
* This method buffers the input internally, so there is no need to use a
* <code>BufferedInputStream</code>.
* <p>
- * The buffer size is given by {@link #DEFAULT_BUFFER_SIZE}.
+ * The buffer size is given by #DEFAULT_BUFFER_SIZE.
*
* @param input the <code>InputStream</code> to read from
* @param output the <code>OutputStream</code> to write to
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Network.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Network.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Network.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Network.java Sat Dec 17 15:18:15 2016
@@ -31,7 +31,10 @@ import java.net.InetAddress;
*/
public final class Network
{
+ /** The loopback address (ie, ::1 or 127.0.0.1 */
public static final InetAddress LOOPBACK = getLoopbackAddress();
+
+ /** The loopback hostname */
public static final String LOOPBACK_HOSTNAME = getLoopbackHostName();
/**
@@ -55,9 +58,14 @@ public final class Network
}
+ /**
+ * Construct a LDAP URL using the loopback address.
+ *
+ * @param port The port
+ * @return The Loopback URL
+ */
public static String ldapLoopbackUrl( int port )
{
return "ldap://" + LOOPBACK_HOSTNAME + ":" + port;
}
-
}
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Serialize.java Sat Dec 17 15:18:15 2016
@@ -26,7 +26,10 @@ package org.apache.directory.api.util;
*/
public final class Serialize
{
+ /** The serialized value for TRUE */
public static final byte TRUE = 0x01;
+
+ /** The serialized value for FALSE */
public static final byte FALSE = 0x00;
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SingletonEnumeration.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SingletonEnumeration.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SingletonEnumeration.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/SingletonEnumeration.java Sat Dec 17 15:18:15 2016
@@ -28,6 +28,8 @@ import java.util.NoSuchElementException;
/**
* A NamingEnumeration over a single element.
*
+ * @param <T> The element in the enumeration
+ *
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class SingletonEnumeration<T> implements NamingEnumeration<T>
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/StringConstants.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/StringConstants.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/StringConstants.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/StringConstants.java Sat Dec 17 15:18:15 2016
@@ -39,6 +39,8 @@ public final class StringConstants
*/
public static final String[] EMPTY_STRINGS = new String[]
{};
+
+ /** A flag used when comparing values */
public static final int NOT_EQUAL = -1;
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java?rev=1774774&r1=1774773&r2=1774774&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java (original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/Strings.java Sat Dec 17 15:18:15 2016
@@ -1172,7 +1172,6 @@ public final class Strings
*
* @param string the string to be trimmed, may be null
* @param pos The position in the String
- * @param pos The starting position
*/
public static void trimLeft( String string, Position pos )
{
@@ -1209,7 +1208,6 @@ public final class Strings
*
* @param bytes the byte array to be trimmed, may be null
* @param pos The position in the byte[]
- * @param pos The starting position
*/
public static void trimLeft( byte[] bytes, Position pos )
{