Code cleanup

Jean-Noel Rouvignac

29.07.2014 d982ffa9b1bdf3cf1fa2b19737134d4714569a5a

 opends/src/server/org/opends/server/core/SearchOperation.java

@@ -47,7 +47,7 @@
   * @return  The raw, unprocessed base DN as included in the request from the
   *          client.
   */
  public abstract ByteString getRawBaseDN();
  ByteString getRawBaseDN();

  /**
   * Specifies the raw, unprocessed base DN as included in the request from the
@@ -56,7 +56,7 @@
   * @param  rawBaseDN  The raw, unprocessed base DN as included in the request
   *                    from the client.
   */
  public abstract void setRawBaseDN(ByteString rawBaseDN);
  void setRawBaseDN(ByteString rawBaseDN);

  /**
   * Retrieves the base DN for this search operation.  This should not be called
@@ -66,7 +66,7 @@
   * @return  The base DN for this search operation, or <CODE>null</CODE> if the
   *          raw base DN has not yet been processed.
   */
  public abstract DN getBaseDN();
  DN getBaseDN();

  /**
   * Specifies the base DN for this search operation.  This method is only
@@ -74,14 +74,14 @@
   *
   * @param  baseDN  The base DN for this search operation.
   */
  public abstract void setBaseDN(DN baseDN);
  void setBaseDN(DN baseDN);

  /**
   * Retrieves the scope for this search operation.
   *
   * @return  The scope for this search operation.
   */
  public abstract SearchScope getScope();
  SearchScope getScope();

  /**
   * Specifies the scope for this search operation.  This should only be called
@@ -89,14 +89,14 @@
   *
   * @param  scope  The scope for this search operation.
   */
  public abstract void setScope(SearchScope scope);
  void setScope(SearchScope scope);

  /**
   * Retrieves the alias dereferencing policy for this search operation.
   *
   * @return  The alias dereferencing policy for this search operation.
   */
  public abstract DereferencePolicy getDerefPolicy();
  DereferencePolicy getDerefPolicy();

  /**
   * Specifies the alias dereferencing policy for this search operation.  This
@@ -105,14 +105,14 @@
   * @param  derefPolicy  The alias dereferencing policy for this search
   *                      operation.
   */
  public abstract void setDerefPolicy(DereferencePolicy derefPolicy);
  void setDerefPolicy(DereferencePolicy derefPolicy);

  /**
   * Retrieves the size limit for this search operation.
   *
   * @return  The size limit for this search operation.
   */
  public abstract int getSizeLimit();
  int getSizeLimit();

  /**
   * Specifies the size limit for this search operation.  This should only be
@@ -120,21 +120,21 @@
   *
   * @param  sizeLimit  The size limit for this search operation.
   */
  public abstract void setSizeLimit(int sizeLimit);
  void setSizeLimit(int sizeLimit);

  /**
   * Retrieves the time limit for this search operation.
   *
   * @return  The time limit for this search operation.
   */
  public abstract int getTimeLimit();
  int getTimeLimit();

  /**
   * Get the time after which the search time limit has expired.
   *
   * @return the timeLimitExpiration
   */
  public abstract long getTimeLimitExpiration();
  long getTimeLimitExpiration();

  /**
   * Specifies the time limit for this search operation.  This should only be
@@ -142,14 +142,14 @@
   *
   * @param  timeLimit  The time limit for this search operation.
   */
  public abstract void setTimeLimit(int timeLimit);
  void setTimeLimit(int timeLimit);

  /**
   * Retrieves the typesOnly flag for this search operation.
   *
   * @return  The typesOnly flag for this search operation.
   */
  public abstract boolean getTypesOnly();
  boolean getTypesOnly();

  /**
   * Specifies the typesOnly flag for this search operation.  This should only
@@ -157,7 +157,7 @@
   *
   * @param  typesOnly  The typesOnly flag for this search operation.
   */
  public abstract void setTypesOnly(boolean typesOnly);
  void setTypesOnly(boolean typesOnly);

  /**
   * Retrieves the raw, unprocessed search filter as included in the request
@@ -168,7 +168,7 @@
   * @return  The raw, unprocessed search filter as included in the request from
   *          the client.
   */
  public abstract RawFilter getRawFilter();
  RawFilter getRawFilter();

  /**
   * Specifies the raw, unprocessed search filter as included in the request
@@ -177,7 +177,7 @@
   * @param  rawFilter  The raw, unprocessed search filter as included in the
   *                    request from the client.
   */
  public abstract void setRawFilter(RawFilter rawFilter);
  void setRawFilter(RawFilter rawFilter);

  /**
   * Retrieves the filter for this search operation.  This should not be called
@@ -187,7 +187,7 @@
   * @return  The filter for this search operation, or <CODE>null</CODE> if the
   *          raw filter has not yet been processed.
   */
  public abstract SearchFilter getFilter();
  SearchFilter getFilter();

  /**
   * Retrieves the set of requested attributes for this search operation.  Its
@@ -195,7 +195,7 @@
   *
   * @return  The set of requested attributes for this search operation.
   */
  public abstract Set<String> getAttributes();
  Set<String> getAttributes();

  /**
   * Specifies the set of requested attributes for this search operation.  It
@@ -204,7 +204,7 @@
   * @param  attributes  The set of requested attributes for this search
   *                     operation.
   */
  public abstract void setAttributes(Set<String> attributes);
  void setAttributes(Set<String> attributes);

  /**
   * Retrieves the number of entries sent to the client for this search
@@ -213,7 +213,7 @@
   * @return  The number of entries sent to the client for this search
   *          operation.
   */
  public abstract int getEntriesSent();
  int getEntriesSent();

  /**
   * Retrieves the number of search references sent to the client for this
@@ -222,7 +222,7 @@
   * @return  The number of search references sent to the client for this search
   *          operation.
   */
  public abstract int getReferencesSent();
  int getReferencesSent();

  /**
   * Used as a callback for backends to indicate that the provided entry matches
@@ -239,7 +239,7 @@
   *          <CODE>false</CODE> if not for some reason (e.g., the size limit
   *          has been reached or the search has been abandoned).
   */
  public abstract boolean returnEntry(Entry entry, List<Control> controls);
  boolean returnEntry(Entry entry, List<Control> controls);

  /**
   * Used as a callback for backends to indicate that the provided entry matches
@@ -258,7 +258,7 @@
   *          <CODE>false</CODE> if not for some reason (e.g., the size limit
   *          has been reached or the search has been abandoned).
   */
  public abstract boolean returnEntry(Entry entry, List<Control> controls,
  boolean returnEntry(Entry entry, List<Control> controls,
                                      boolean evaluateAci);

  /**
@@ -274,7 +274,7 @@
   *          <CODE>false</CODE> if not for some reason (e.g., the size limit
   *          has been reached or the search has been abandoned).
   */
  public abstract boolean returnReference(DN dn,
  boolean returnReference(DN dn,
                                          SearchResultReference reference);

  /**
@@ -292,7 +292,7 @@
   *          <CODE>false</CODE> if not for some reason (e.g., the size limit
   *          has been reached or the search has been abandoned).
   */
  public abstract boolean returnReference(DN dn,
  boolean returnReference(DN dn,
                                          SearchResultReference reference,
                                          boolean evaluateAci);

@@ -304,43 +304,43 @@
   * message should have been set for this operation before this method is
   * called.
   */
  public abstract void sendSearchResultDone();
  void sendSearchResultDone();

  /**
   * Set the time after which the search time limit has expired.
   *
   * @param timeLimitExpiration - Time after which the search has expired
   */
  public abstract void setTimeLimitExpiration(long timeLimitExpiration);
  void setTimeLimitExpiration(long timeLimitExpiration);

  /**
   * Indicates whether LDAP subentries should be returned or not.
   *
   * @return true if the LDAP subentries should be returned, false otherwise
   */
  public abstract boolean isReturnSubentriesOnly();
  boolean isReturnSubentriesOnly();

  /**
   * Set the flag indicating wether the LDAP subentries should be returned.
   * Set the flag indicating whether the LDAP subentries should be returned.
   *
   * @param returnLDAPSubentries - Boolean indicating wether the LDAP
   * @param returnLDAPSubentries - Boolean indicating whether the LDAP
   *                               subentries should be returned or not
   */
  public abstract void setReturnSubentriesOnly(boolean returnLDAPSubentries);
  void setReturnSubentriesOnly(boolean returnLDAPSubentries);

  /**
   * The matched values control associated with this search operation.
   *
   * @return the match values control
   */
  public abstract MatchedValuesControl getMatchedValuesControl();
  MatchedValuesControl getMatchedValuesControl();

  /**
   * Set the match values control.
   *
   * @param controls - The matched values control
   */
  public abstract void setMatchedValuesControl(MatchedValuesControl controls);
  void setMatchedValuesControl(MatchedValuesControl controls);

  /**
   * Indicates whether to include the account usable response control with
@@ -349,7 +349,7 @@
   * @return true if the usable control has to be part of the search result
   *         entry
   */
  public abstract boolean isIncludeUsableControl();
  boolean isIncludeUsableControl();

  /**
   * Specify whether to include the account usable response control within the
@@ -359,14 +359,14 @@
   *                               has to be included within the search result
   *                               entries, false otherwise
   */
  public abstract void setIncludeUsableControl(boolean includeUsableControl);
  void setIncludeUsableControl(boolean includeUsableControl);

  /**
   * Indicates whether the client is able to handle referrals.
   *
   * @return true, if the client is able to handle referrals
   */
  public abstract boolean isClientAcceptsReferrals();
  boolean isClientAcceptsReferrals();

  /**
   * Specify whether the client is able to handle referrals.
@@ -374,51 +374,39 @@
   * @param clientAcceptReferrals - Boolean set to true if the client
   *                                can handle referrals
   */
  public abstract void setClientAcceptsReferrals(boolean clientAcceptReferrals);
  void setClientAcceptsReferrals(boolean clientAcceptReferrals);

  /**
   * Increments by 1 the number of entries sent to the client for this search
   * operation.
   */
  public abstract void incrementEntriesSent();

  /**
   * Increments by 1 the number of search references sent to the client for this
   * search operation.
   */
  public abstract void incrementReferencesSent();

  /**
   * Indicates wether the search result done message has to be sent
   * Indicates whether the search result done message has to be sent
   * to the client, or not.
   *
   * @return true if the search result done message is to be sent to the client
   */
  public abstract boolean isSendResponse();
  boolean isSendResponse();

  /**
   * Specify wether the search result done message has to be sent
   * Specify whether the search result done message has to be sent
   * to the client, or not.
   *
   * @param sendResponse - boolean indicating wether the search result done
   * @param sendResponse - boolean indicating whether the search result done
   *                       message is to send to the client
   */
  public abstract void setSendResponse(boolean sendResponse);
  void setSendResponse(boolean sendResponse);

  /**
   * Returns true if only real attributes should be returned.
   *
   * @return true if only real attributes should be returned, false otherwise
   */
  public abstract boolean isRealAttributesOnly();
  boolean isRealAttributesOnly();

  /**
   * Specify wether to only return real attributes.
   * Specify whether to only return real attributes.
   *
   * @param realAttributesOnly - boolean setup to true, if only the real
   *                             attributes should be returned
   */
  public abstract void setRealAttributesOnly(boolean realAttributesOnly);
  void setRealAttributesOnly(boolean realAttributesOnly);

  /**
   * Returns true if only virtual attributes should be returned.
@@ -426,15 +414,15 @@
   * @return true if only virtual attributes should be returned, false
   *         otherwise
   */
  public abstract boolean isVirtualAttributesOnly();
  boolean isVirtualAttributesOnly();

  /**
   * Specify wether to only return virtual attributes.
   * Specify whether to only return virtual attributes.
   *
   * @param virtualAttributesOnly - boolean setup to true, if only the virtual
   *                                attributes should be returned
   */
  public abstract void setVirtualAttributesOnly(boolean virtualAttributesOnly);
  void setVirtualAttributesOnly(boolean virtualAttributesOnly);

  /**
   * Sends the provided search result entry to the client.
@@ -446,7 +434,7 @@
   *                              to send the entry to the client and
   *                              the search should be terminated.
   */
  public abstract void sendSearchEntry(SearchResultEntry entry)
  void sendSearchEntry(SearchResultEntry entry)
    throws DirectoryException;

  /**
@@ -464,7 +452,7 @@
   *                              to send the reference to the client
   *                              and the search should be terminated.
   */
  public abstract boolean sendSearchReference(SearchResultReference reference)
  boolean sendSearchReference(SearchResultReference reference)
    throws DirectoryException;

  /**
@@ -475,7 +463,7 @@
   *          authorization has been requested, or {@code null} if proxied
   *          authorization has not been requested.
   */
  public abstract DN getProxiedAuthorizationDN();
  DN getProxiedAuthorizationDN();

  /**
   * Set the proxied authorization DN for this operation if proxied
@@ -486,6 +474,6 @@
   *          authorization has been requested, or {@code null} if proxied
   *          authorization has not been requested.
   */
  public abstract void setProxiedAuthorizationDN(DN proxiedAuthorizationDN);
  void setProxiedAuthorizationDN(DN proxiedAuthorizationDN);

}