From 5b388cb5c60bbb3b73b5be17a913a49e609a6e7a Mon Sep 17 00:00:00 2001 From: Mattias Hellborg Arthursson Date: Wed, 25 Sep 2013 12:40:45 +0200 Subject: [PATCH] LDAP-263: Minor javadoc polishing. --- .../springframework/ldap/core/LdapOperations.java | 13 ++++++++++--- .../ldap/query/LdapQueryBuilder.java | 1 + .../springframework/ldap/query/SearchScope.java | 1 + .../springframework/ldap/odm/core/OdmManager.java | 15 ++++++++------- 4 files changed, 20 insertions(+), 10 deletions(-) diff --git a/core/src/main/java/org/springframework/ldap/core/LdapOperations.java b/core/src/main/java/org/springframework/ldap/core/LdapOperations.java index 8ecdf700..2089fa0f 100644 --- a/core/src/main/java/org/springframework/ldap/core/LdapOperations.java +++ b/core/src/main/java/org/springframework/ldap/core/LdapOperations.java @@ -1527,6 +1527,7 @@ public interface LdapOperations { * @throws NamingException if something went wrong in authentication. * * @since 2.0 + * @see org.springframework.ldap.query.LdapQueryBuilder */ T authenticate(LdapQuery query, String password, AuthenticatedLdapEntryContextMapper mapper); @@ -1551,6 +1552,7 @@ public interface LdapOperations { * @throws NamingException if something went wrong in authentication. * * @since 2.0 + * @see org.springframework.ldap.query.LdapQueryBuilder */ void authenticate(LdapQuery query, String password); @@ -1628,12 +1630,14 @@ public interface LdapOperations { * * @throws NamingException if any error occurs. * @since 2.0 + * @see org.springframework.ldap.query.LdapQueryBuilder */ List search(LdapQuery query, ContextMapper mapper); /** - * Perform a search with parameters from the specified LdapQuery. The Attributes of the found entrieswill be supplied to the - * AttributesMapper for processing, and all returned objects will be collected in a list to be returned. + * Perform a search with parameters from the specified LdapQuery. The Attributes of the found entries will be + * supplied to the AttributesMapper for processing, and all + * returned objects will be collected in a list to be returned. * * @param query the LDAP query specification. * @param mapper the Attributes to supply all found Attributes to. @@ -1642,6 +1646,7 @@ public interface LdapOperations { * * @throws NamingException if any error occurs. * @since 2.0 + * @see org.springframework.ldap.query.LdapQueryBuilder */ List search(LdapQuery query, AttributesMapper mapper); @@ -1650,10 +1655,11 @@ public interface LdapOperations { * query and return the found entry as a DirContextOperation instance. If no entry is found or if there * are more than one matching entry, an * {@link IncorrectResultSizeDataAccessException} is thrown. - * @param query the DN to use as the base of the search. + * @param query the LDAP query specification. * @return the single entry matching the query as a DirContextOperations instance. * @throws IncorrectResultSizeDataAccessException if the result is not one unique entry * @since 2.0 + * @see org.springframework.ldap.query.LdapQueryBuilder */ DirContextOperations searchForContext(LdapQuery query); @@ -1667,6 +1673,7 @@ public interface LdapOperations { * criteria. * @throws IncorrectResultSizeDataAccessException if the result is not one unique entry * @since 2.0 + * @see org.springframework.ldap.query.LdapQueryBuilder */ T searchForObject(LdapQuery query, ContextMapper mapper); } diff --git a/core/src/main/java/org/springframework/ldap/query/LdapQueryBuilder.java b/core/src/main/java/org/springframework/ldap/query/LdapQueryBuilder.java index 8933c164..dfa73e34 100644 --- a/core/src/main/java/org/springframework/ldap/query/LdapQueryBuilder.java +++ b/core/src/main/java/org/springframework/ldap/query/LdapQueryBuilder.java @@ -45,6 +45,7 @@ import java.text.MessageFormat; * defaults will be used. Filter conditions must always be specified. *

* @author Mattias Hellborg Arthursson + * @since 2.0 * * @see javax.naming.directory.SearchControls * @see org.springframework.ldap.core.LdapOperations#search(LdapQuery, org.springframework.ldap.core.AttributesMapper) diff --git a/core/src/main/java/org/springframework/ldap/query/SearchScope.java b/core/src/main/java/org/springframework/ldap/query/SearchScope.java index e18db50d..a396b53d 100644 --- a/core/src/main/java/org/springframework/ldap/query/SearchScope.java +++ b/core/src/main/java/org/springframework/ldap/query/SearchScope.java @@ -22,6 +22,7 @@ import javax.naming.directory.SearchControls; * Type safe definitions of search scopes. * * @author Mattias Hellborg Arthursson + * @since 2.0 */ public enum SearchScope { /** diff --git a/odm/src/main/java/org/springframework/ldap/odm/core/OdmManager.java b/odm/src/main/java/org/springframework/ldap/odm/core/OdmManager.java index f146d66a..dc8d52b7 100755 --- a/odm/src/main/java/org/springframework/ldap/odm/core/OdmManager.java +++ b/odm/src/main/java/org/springframework/ldap/odm/core/OdmManager.java @@ -48,7 +48,7 @@ public interface OdmManager { * @param dn The distinguished name of the entry to read from the LDAP directory. * @return The entry as read from the directory * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. */ T read(Class clazz, Name dn); @@ -57,7 +57,7 @@ public interface OdmManager { * * @param entry The entry to be create, it must not already exist in the directory. * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. */ void create(Object entry); @@ -66,7 +66,7 @@ public interface OdmManager { * * @param entry The entry to update, it must already exist in the directory. * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. */ void update(Object entry); @@ -75,7 +75,7 @@ public interface OdmManager { * * @param entry The entry to delete, it must already exist in the directory. * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. */ void delete(Object entry); @@ -89,7 +89,7 @@ public interface OdmManager { * @return All entries that are of the type represented by the given * Java class * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. */ List findAll(Class clazz, Name base, SearchControls searchControls); @@ -106,7 +106,7 @@ public interface OdmManager { * @param searchControls The scope of the search. * @return All matching entries. * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. * * @see Sun's JNDI tutorial description of search filters. * @see LDAP: String Representation of Search Filters RFC. @@ -124,7 +124,8 @@ public interface OdmManager { * @param query the LDAP query specification * @return All matching entries. * - * @exception org.springframework.ldap.NamingException on error. + * @throws org.springframework.ldap.NamingException on error. + * @see org.springframework.ldap.query.LdapQueryBuilder */ List search(Class clazz, LdapQuery query); }