From f2160f4bd1c8ac67e5a86a6710d431e8932877f9 Mon Sep 17 00:00:00 2001
From: matthew_swift <matthew_swift@localhost>
Date: Fri, 28 May 2010 11:47:51 +0000
Subject: [PATCH] Synchronize SDK on java.net with internal repository.
---
sdk/src/org/opends/sdk/SearchScope.java | 96 +++++++++++++++++++++++------------------------
1 files changed, 47 insertions(+), 49 deletions(-)
diff --git a/sdk/src/org/opends/sdk/SearchScope.java b/sdk/src/org/opends/sdk/SearchScope.java
index 7f02192..04ec469 100644
--- a/sdk/src/org/opends/sdk/SearchScope.java
+++ b/sdk/src/org/opends/sdk/SearchScope.java
@@ -36,16 +36,15 @@
/**
- * A Search operation search scope as defined in RFC 4511 section
- * 4.5.1.2 is used to specify the scope of a Search operation.
+ * A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is
+ * used to specify the scope of a Search operation.
*
- * @see <a href="http://tools.ietf.org/html/rfc4511#section-4.5.1.2">RFC
- * 4511 - Lightweight Directory Access Protocol (LDAP): The
- * Protocol </a>
+ * @see <a href="http://tools.ietf.org/html/rfc4511#section-4.5.1.2">RFC 4511 -
+ * Lightweight Directory Access Protocol (LDAP): The Protocol </a>
* @see <a
* href="http://tools.ietf.org/html/draft-sermersheim-ldap-subordinate-scope">
- * draft-sermersheim-ldap-subordinate-scope - Subordinate Subtree
- * Search Scope for LDAP </a>
+ * draft-sermersheim-ldap-subordinate-scope - Subordinate Subtree Search
+ * Scope for LDAP </a>
*/
public final class SearchScope
{
@@ -60,8 +59,8 @@
public static final SearchScope BASE_OBJECT = register(0, "base");
/**
- * The scope is constrained to the immediate subordinates of the
- * search base entry.
+ * The scope is constrained to the immediate subordinates of the search base
+ * entry.
*/
public static final SearchScope SINGLE_LEVEL = register(1, "one");
@@ -72,44 +71,23 @@
public static final SearchScope WHOLE_SUBTREE = register(2, "sub");
/**
- * The scope is constrained to all the subordinates of the search base
- * entry, but does not include the search base entry itself (as
- * wholeSubtree does).
+ * The scope is constrained to all the subordinates of the search base entry,
+ * but does not include the search base entry itself (as wholeSubtree does).
*/
- public static final SearchScope SUBORDINATES = register(3,
- "subordinates");
+ public static final SearchScope SUBORDINATES = register(3, "subordinates");
/**
- * Creates and registers a new search scope with the application.
- *
- * @param intValue
- * The integer value of the search scope as defined in RFC
- * 4511 section 4.5.1.2.
- * @param name
- * The name of the search scope as defined in RFC 4516.
- * @return The new search scope.
- */
- private static SearchScope register(int intValue, String name)
- {
- SearchScope t = new SearchScope(intValue, name);
- ELEMENTS[intValue] = t;
- return t;
- }
-
-
-
- /**
- * Returns the search scope having the specified integer value as
- * defined in RFC 4511 section 4.5.1.2.
+ * Returns the search scope having the specified integer value as defined in
+ * RFC 4511 section 4.5.1.2.
*
* @param intValue
* The integer value of the search scope.
- * @return The search scope, or {@code null} if there was no search
- * scope associated with {@code intValue}.
+ * @return The search scope, or {@code null} if there was no search scope
+ * associated with {@code intValue}.
*/
- public static SearchScope valueOf(int intValue)
+ public static SearchScope valueOf(final int intValue)
{
if (intValue < 0 || intValue >= ELEMENTS.length)
{
@@ -121,12 +99,10 @@
/**
- * Returns an unmodifiable list containing the set of available search
- * scopes indexed on their integer value as defined in RFC 4511
- * section 4.5.1.2.
+ * Returns an unmodifiable list containing the set of available search scopes
+ * indexed on their integer value as defined in RFC 4511 section 4.5.1.2.
*
- * @return An unmodifiable list containing the set of available search
- * scopes.
+ * @return An unmodifiable list containing the set of available search scopes.
*/
public static List<SearchScope> values()
{
@@ -135,6 +111,25 @@
+ /**
+ * Creates and registers a new search scope with the application.
+ *
+ * @param intValue
+ * The integer value of the search scope as defined in RFC 4511
+ * section 4.5.1.2.
+ * @param name
+ * The name of the search scope as defined in RFC 4516.
+ * @return The new search scope.
+ */
+ private static SearchScope register(final int intValue, final String name)
+ {
+ final SearchScope t = new SearchScope(intValue, name);
+ ELEMENTS[intValue] = t;
+ return t;
+ }
+
+
+
private final int intValue;
private final String name;
@@ -142,7 +137,7 @@
// Prevent direct instantiation.
- private SearchScope(int intValue, String name)
+ private SearchScope(final int intValue, final String name)
{
this.intValue = intValue;
this.name = name;
@@ -153,7 +148,8 @@
/**
* {@inheritDoc}
*/
- public boolean equals(Object obj)
+ @Override
+ public boolean equals(final Object obj)
{
if (this == obj)
{
@@ -174,6 +170,7 @@
/**
* {@inheritDoc}
*/
+ @Override
public int hashCode()
{
return intValue;
@@ -182,8 +179,8 @@
/**
- * Returns the integer value of this search scope as defined in RFC
- * 4511 section 4.5.1.2.
+ * Returns the integer value of this search scope as defined in RFC 4511
+ * section 4.5.1.2.
*
* @return The integer value of this search scope.
*/
@@ -195,11 +192,12 @@
/**
- * Returns the string representation of this search scope as defined
- * in RFC 4516.
+ * Returns the string representation of this search scope as defined in RFC
+ * 4516.
*
* @return The string representation of this search scope.
*/
+ @Override
public String toString()
{
return name;
--
Gitblit v1.10.0