From cc2560ef19fbd97fb66403a467c875223f978605 Mon Sep 17 00:00:00 2001 From: Josh Cummings Date: Tue, 9 May 2023 13:01:29 -0600 Subject: [PATCH] Align JavaDoc Formatting in Core Closes gh-748 --- .../ldap/core/AttributesMapper.java | 2 +- .../CollectingNameClassPairCallbackHandler.java | 2 +- .../ldap/core/ContextExecutor.java | 2 +- .../springframework/ldap/core/ContextMapper.java | 2 +- .../springframework/ldap/core/ContextSource.java | 2 +- .../ldap/core/DirContextAdapter.java | 8 ++++---- .../ldap/core/DistinguishedName.java | 4 ++-- .../ldap/core/LdapOperations.java | 16 ++++++++-------- .../springframework/ldap/core/LdapTemplate.java | 2 +- .../ldap/core/SearchExecutor.java | 2 +- .../ldap/core/support/AbstractContextSource.java | 6 +++--- .../support/BaseLdapPathBeanPostProcessor.java | 2 +- .../ldap/core/support/BaseLdapPathSource.java | 2 +- .../core/support/ContextMapperWithControls.java | 4 ++-- .../DefaultIncrementalAttributesMapper.java | 2 +- .../ldap/core/support/DirContextSource.java | 2 +- .../ldap/core/support/LdapContextSource.java | 2 +- .../ldap/core/support/RangeOption.java | 2 +- .../ldap/core/support/SingleContextSource.java | 2 +- .../ldap/filter/AbsoluteFalseFilter.java | 2 +- .../ldap/filter/AbsoluteTrueFilter.java | 2 +- .../springframework/ldap/filter/AndFilter.java | 2 +- .../ldap/pool2/DelegatingContext.java | 2 +- .../ldap/pool2/DelegatingDirContext.java | 2 +- .../ldap/pool2/DelegatingLdapContext.java | 2 +- .../ldap/pool2/MutableDelegatingLdapContext.java | 2 +- .../factory/DirContextPoolableObjectFactory.java | 2 +- .../factory/MutablePooledContextSource.java | 2 +- .../ldap/pool2/factory/PooledContextSource.java | 2 +- .../ldap/query/ConditionCriteria.java | 2 +- .../springframework/ldap/support/LdapUtils.java | 2 +- .../manager/ContextSourceTransactionManager.java | 2 +- .../ContextSourceTransactionManagerDelegate.java | 2 +- .../CompensatingTransactionOperationFactory.java | 2 +- 34 files changed, 48 insertions(+), 48 deletions(-) diff --git a/core/src/main/java/org/springframework/ldap/core/AttributesMapper.java b/core/src/main/java/org/springframework/ldap/core/AttributesMapper.java index caf3161b..429d9745 100644 --- a/core/src/main/java/org/springframework/ldap/core/AttributesMapper.java +++ b/core/src/main/java/org/springframework/ldap/core/AttributesMapper.java @@ -32,10 +32,10 @@ import javax.naming.directory.Attributes; *

* Alternatively, consider using a {@link ContextMapper} in stead. * + * @author Mattias Hellborg Arthursson * @see LdapTemplate#search(Name, String, AttributesMapper) * @see LdapTemplate#lookup(Name, AttributesMapper) * @see ContextMapper - * @author Mattias Hellborg Arthursson */ public interface AttributesMapper { diff --git a/core/src/main/java/org/springframework/ldap/core/CollectingNameClassPairCallbackHandler.java b/core/src/main/java/org/springframework/ldap/core/CollectingNameClassPairCallbackHandler.java index f788994a..707117a5 100644 --- a/core/src/main/java/org/springframework/ldap/core/CollectingNameClassPairCallbackHandler.java +++ b/core/src/main/java/org/springframework/ldap/core/CollectingNameClassPairCallbackHandler.java @@ -25,8 +25,8 @@ import javax.naming.NamingException; /** * A NameClassPairCallbackHandler to collect all results in an internal List. * - * @see LdapTemplate * @author Mattias Hellborg Arthursson + * @see LdapTemplate */ public abstract class CollectingNameClassPairCallbackHandler implements NameClassPairCallbackHandler { diff --git a/core/src/main/java/org/springframework/ldap/core/ContextExecutor.java b/core/src/main/java/org/springframework/ldap/core/ContextExecutor.java index 8b48ebf2..50eff38f 100644 --- a/core/src/main/java/org/springframework/ldap/core/ContextExecutor.java +++ b/core/src/main/java/org/springframework/ldap/core/ContextExecutor.java @@ -32,9 +32,9 @@ import javax.naming.directory.DirContext; * }; * * + * @author Mattias Hellborg Arthursson * @see LdapTemplate#executeReadOnly(ContextExecutor) * @see LdapTemplate#executeReadWrite(ContextExecutor) - * @author Mattias Hellborg Arthursson */ public interface ContextExecutor { diff --git a/core/src/main/java/org/springframework/ldap/core/ContextMapper.java b/core/src/main/java/org/springframework/ldap/core/ContextMapper.java index 2c775cfc..2f8bfe9d 100644 --- a/core/src/main/java/org/springframework/ldap/core/ContextMapper.java +++ b/core/src/main/java/org/springframework/ldap/core/ContextMapper.java @@ -38,6 +38,7 @@ import org.springframework.ldap.core.support.DefaultDirObjectFactory; *

* Alternatively, consider using an {@link AttributesMapper} in stead. * + * @author Mattias Hellborg Arthursson * @see LdapTemplate#search(Name, String, ContextMapper) * @see LdapTemplate#listBindings(Name, ContextMapper) * @see LdapTemplate#lookup(Name, ContextMapper) @@ -45,7 +46,6 @@ import org.springframework.ldap.core.support.DefaultDirObjectFactory; * @see DefaultDirObjectFactory * @see DirContextAdapter * @see AbstractContextMapper - * @author Mattias Hellborg Arthursson */ public interface ContextMapper { diff --git a/core/src/main/java/org/springframework/ldap/core/ContextSource.java b/core/src/main/java/org/springframework/ldap/core/ContextSource.java index bcc4858f..9c5e954a 100644 --- a/core/src/main/java/org/springframework/ldap/core/ContextSource.java +++ b/core/src/main/java/org/springframework/ldap/core/ContextSource.java @@ -26,9 +26,9 @@ import org.springframework.ldap.NamingException; * acquiring contexts for LDAP operations, but may be used standalone to perform LDAP * authentication. * - * @see org.springframework.ldap.core.LdapTemplate * @author Adam Skogman * @author Mattias Hellborg Arthursson + * @see org.springframework.ldap.core.LdapTemplate */ public interface ContextSource { diff --git a/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java b/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java index a0c61c5d..4c26eb86 100644 --- a/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java +++ b/core/src/main/java/org/springframework/ldap/core/DirContextAdapter.java @@ -82,6 +82,10 @@ import org.springframework.util.StringUtils; * UnsupportOperationException. *

* + * @author Magnus Robertsson + * @author Andreas Ronge + * @author Adam Skogman + * @author Mattias Hellborg Arthursson * @see #setAttributeValue(String, Object) * @see #setAttributeValues(String, Object[]) * @see #getStringAttribute(String) @@ -91,10 +95,6 @@ import org.springframework.util.StringUtils; * @see #removeAttributeValue(String, Object) * @see #setUpdateMode(boolean) * @see #isUpdateMode() - * @author Magnus Robertsson - * @author Andreas Ronge - * @author Adam Skogman - * @author Mattias Hellborg Arthursson */ public class DirContextAdapter implements DirContextOperations { diff --git a/core/src/main/java/org/springframework/ldap/core/DistinguishedName.java b/core/src/main/java/org/springframework/ldap/core/DistinguishedName.java index 7fbfc09a..9fc3cbfc 100644 --- a/core/src/main/java/org/springframework/ldap/core/DistinguishedName.java +++ b/core/src/main/java/org/springframework/ldap/core/DistinguishedName.java @@ -90,12 +90,12 @@ import org.springframework.util.StringUtils; * * @author Adam Skogman * @author Mattias Hellborg Arthursson - * @deprecated As of 2.0 it is recommended to use {@link javax.naming.ldap.LdapName} along - * with utility methods in {@link LdapUtils} instead. * @see javax.naming.ldap.LdapName * @see LdapUtils#newLdapName(javax.naming.Name) * @see LdapUtils#newLdapName(String) * @see org.springframework.ldap.support.LdapUtils#emptyLdapName() + * @deprecated As of 2.0 it is recommended to use {@link javax.naming.ldap.LdapName} along + * with utility methods in {@link LdapUtils} instead. */ public class DistinguishedName implements Name { 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 34dd9250..9d3a64d6 100644 --- a/core/src/main/java/org/springframework/ldap/core/LdapOperations.java +++ b/core/src/main/java/org/springframework/ldap/core/LdapOperations.java @@ -1058,9 +1058,9 @@ public interface LdapOperations { * registered with the ContextSource, causing the actual class of the * returned object to be something else than {@link DirContextOperations}. * @throws NamingException if any other error occurs. + * @since 1.2 * @see #lookup(Name) * @see #modifyAttributes(DirContextOperations) - * @since 1.2 */ DirContextOperations lookupContext(Name dn) throws NamingException, ClassCastException; @@ -1073,9 +1073,9 @@ public interface LdapOperations { * registered with the ContextSource, causing the actual class of the * returned object to be something else than {@link DirContextOperations}. * @throws NamingException if any other error occurs. + * @since 1.2 * @see #lookup(String) * @see #modifyAttributes(DirContextOperations) - * @since 1.2 */ DirContextOperations lookupContext(String dn) throws NamingException, ClassCastException; @@ -1220,11 +1220,11 @@ public interface LdapOperations { * DirContext authenticated with the found user. * @return true if the authentication was successful, false * otherwise. - * @see #authenticate(Name, String, String) * @since 1.3 * @deprecated use * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String)} or * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String, AuthenticatedLdapEntryContextMapper)} + * @see #authenticate(Name, String, String) */ boolean authenticate(Name base, String filter, String password, AuthenticatedLdapEntryContextCallback callback); @@ -1243,11 +1243,11 @@ public interface LdapOperations { * DirContext authenticated with the found user. * @return true if the authentication was successful, false * otherwise. - * @see #authenticate(String, String, String) * @since 1.3 * @deprecated use * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String)} or * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String, AuthenticatedLdapEntryContextMapper)} + * @see #authenticate(String, String, String) */ boolean authenticate(String base, String filter, String password, AuthenticatedLdapEntryContextCallback callback); @@ -1270,11 +1270,11 @@ public interface LdapOperations { * @param errorCallback the callback that will be called if an exception is caught. * @return true if the authentication was successful, false * otherwise. - * @see #authenticate(Name, String, String, AuthenticatedLdapEntryContextCallback) * @since 1.3.1 * @deprecated use * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String)} or * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String, AuthenticatedLdapEntryContextMapper)} + * @see #authenticate(Name, String, String, AuthenticatedLdapEntryContextCallback) */ boolean authenticate(Name base, String filter, String password, AuthenticatedLdapEntryContextCallback callback, AuthenticationErrorCallback errorCallback); @@ -1298,11 +1298,11 @@ public interface LdapOperations { * @param errorCallback the callback that will be called if an exception is caught. * @return true if the authentication was successful, false * otherwise. - * @see #authenticate(String, String, String, AuthenticatedLdapEntryContextCallback) * @since 1.3.1 * @deprecated use * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String)} or * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String, AuthenticatedLdapEntryContextMapper)} + * @see #authenticate(String, String, String, AuthenticatedLdapEntryContextCallback) */ boolean authenticate(String base, String filter, String password, AuthenticatedLdapEntryContextCallback callback, AuthenticationErrorCallback errorCallback); @@ -1321,12 +1321,12 @@ public interface LdapOperations { * @param errorCallback the callback that will be called if an exception is caught. * @return true if the authentication was successful, false * otherwise. - * @see #authenticate(Name, String, String, AuthenticatedLdapEntryContextCallback, - * AuthenticationErrorCallback) * @since 1.3.1 * @deprecated use * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String)} or * {@link #authenticate(org.springframework.ldap.query.LdapQuery, String, AuthenticatedLdapEntryContextMapper)} + * @see #authenticate(Name, String, String, AuthenticatedLdapEntryContextCallback, + * AuthenticationErrorCallback) */ boolean authenticate(Name base, String filter, String password, AuthenticationErrorCallback errorCallback); diff --git a/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java b/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java index 95cce37b..eb229ffd 100644 --- a/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java +++ b/core/src/main/java/org/springframework/ldap/core/LdapTemplate.java @@ -72,9 +72,9 @@ import org.springframework.util.CollectionUtils; * Neither is there any simple way to get notified that a * PartialResultException has been ignored (other than in the log). * - * @see org.springframework.ldap.core.ContextSource * @author Mattias Hellborg Arthursson * @author Ulrik Sandberg + * @see org.springframework.ldap.core.ContextSource */ public class LdapTemplate implements LdapOperations, InitializingBean { diff --git a/core/src/main/java/org/springframework/ldap/core/SearchExecutor.java b/core/src/main/java/org/springframework/ldap/core/SearchExecutor.java index b28d6b83..64a2824e 100644 --- a/core/src/main/java/org/springframework/ldap/core/SearchExecutor.java +++ b/core/src/main/java/org/springframework/ldap/core/SearchExecutor.java @@ -32,9 +32,9 @@ import javax.naming.directory.DirContext; * } * * + * @author Mattias Hellborg Arthursson * @see org.springframework.ldap.core.LdapTemplate#search(SearchExecutor, * NameClassPairCallbackHandler) - * @author Mattias Hellborg Arthursson */ public interface SearchExecutor { diff --git a/core/src/main/java/org/springframework/ldap/core/support/AbstractContextSource.java b/core/src/main/java/org/springframework/ldap/core/support/AbstractContextSource.java index 70cdf45f..3fc90da0 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/AbstractContextSource.java +++ b/core/src/main/java/org/springframework/ldap/core/support/AbstractContextSource.java @@ -61,13 +61,13 @@ import org.springframework.util.StringUtils; * necessary to call {@link #afterPropertiesSet()} when all properties are set, in order * to finish up initialization. * + * @author Mattias Hellborg Arthursson + * @author Adam Skogman + * @author Ulrik Sandberg * @see org.springframework.ldap.core.LdapTemplate * @see org.springframework.ldap.core.support.DefaultDirObjectFactory * @see org.springframework.ldap.core.support.LdapContextSource * @see org.springframework.ldap.core.support.DirContextSource - * @author Mattias Hellborg Arthursson - * @author Adam Skogman - * @author Ulrik Sandberg */ public abstract class AbstractContextSource implements BaseLdapPathContextSource, InitializingBean { diff --git a/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathBeanPostProcessor.java b/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathBeanPostProcessor.java index 749c1c69..5914883b 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathBeanPostProcessor.java +++ b/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathBeanPostProcessor.java @@ -172,8 +172,8 @@ public class BaseLdapPathBeanPostProcessor implements BeanPostProcessor, Applica * Set the order value of this object for sorting purposes. * @param order the order of this instance. Defaults to * Ordered.LOWEST_PRECEDENCE. - * @see Ordered * @since 1.3.2 + * @see Ordered */ public void setOrder(int order) { this.order = order; diff --git a/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathSource.java b/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathSource.java index 7dcc533f..a1a5f059 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathSource.java +++ b/core/src/main/java/org/springframework/ldap/core/support/BaseLdapPathSource.java @@ -26,8 +26,8 @@ import org.springframework.ldap.core.DistinguishedName; * LDAP path is the root path to which all LDAP operations performed on a particular * context are relative. * - * @see ContextSource * @author Mattias Hellborg Arthursson + * @see ContextSource */ public interface BaseLdapPathSource { diff --git a/core/src/main/java/org/springframework/ldap/core/support/ContextMapperWithControls.java b/core/src/main/java/org/springframework/ldap/core/support/ContextMapperWithControls.java index 5014e94d..8a795faa 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/ContextMapperWithControls.java +++ b/core/src/main/java/org/springframework/ldap/core/support/ContextMapperWithControls.java @@ -28,10 +28,10 @@ import org.springframework.ldap.core.ContextMapper; * {@link #mapFromContextWithControls(Object, javax.naming.ldap.HasControls)} method to be * the type parameter T. * - * @author Tim Terry - * @author Ulrik Sandberg * @param return type of the * {@link #mapFromContextWithControls(Object, javax.naming.ldap.HasControls)} method + * @author Tim Terry + * @author Ulrik Sandberg */ public interface ContextMapperWithControls extends ContextMapper { diff --git a/core/src/main/java/org/springframework/ldap/core/support/DefaultIncrementalAttributesMapper.java b/core/src/main/java/org/springframework/ldap/core/support/DefaultIncrementalAttributesMapper.java index d8261288..c26c523d 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/DefaultIncrementalAttributesMapper.java +++ b/core/src/main/java/org/springframework/ldap/core/support/DefaultIncrementalAttributesMapper.java @@ -68,13 +68,13 @@ import org.springframework.ldap.support.LdapUtils; * * @author Marius Scurtescu * @author Mattias Hellborg Arthursson + * @since 1.3.2 * @see Incremental * Retrieval of Multi-valued Properties * @see #lookupAttributes(org.springframework.ldap.core.LdapOperations, javax.naming.Name, * String[]) * @see #lookupAttributeValues(org.springframework.ldap.core.LdapOperations, * javax.naming.Name, String) - * @since 1.3.2 */ public class DefaultIncrementalAttributesMapper implements IncrementalAttributesMapper { diff --git a/core/src/main/java/org/springframework/ldap/core/support/DirContextSource.java b/core/src/main/java/org/springframework/ldap/core/support/DirContextSource.java index 22f95575..7cefe68e 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/DirContextSource.java +++ b/core/src/main/java/org/springframework/ldap/core/support/DirContextSource.java @@ -28,8 +28,8 @@ import javax.naming.directory.InitialDirContext; * {@link org.springframework.ldap.core.support.AbstractContextSource * AbstractContextSource}. * - * @see org.springframework.ldap.core.support.AbstractContextSource * @author Mattias Hellborg Arthursson + * @see org.springframework.ldap.core.support.AbstractContextSource */ public class DirContextSource extends AbstractContextSource { diff --git a/core/src/main/java/org/springframework/ldap/core/support/LdapContextSource.java b/core/src/main/java/org/springframework/ldap/core/support/LdapContextSource.java index 69dda51c..0d013c01 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/LdapContextSource.java +++ b/core/src/main/java/org/springframework/ldap/core/support/LdapContextSource.java @@ -28,10 +28,10 @@ import javax.naming.ldap.InitialLdapContext; * {@link org.springframework.ldap.core.support.AbstractContextSource * AbstractContextSource}. * - * @see org.springframework.ldap.core.support.AbstractContextSource * @author Mattias Hellborg Arthursson * @author Adam Skogman * @author Ulrik Sandberg + * @see org.springframework.ldap.core.support.AbstractContextSource */ public class LdapContextSource extends AbstractContextSource { diff --git a/core/src/main/java/org/springframework/ldap/core/support/RangeOption.java b/core/src/main/java/org/springframework/ldap/core/support/RangeOption.java index 2db0c1fa..9e17af82 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/RangeOption.java +++ b/core/src/main/java/org/springframework/ldap/core/support/RangeOption.java @@ -24,8 +24,8 @@ import java.util.regex.Pattern; * Properties. * * @author Marius Scurtescu - * @see DefaultIncrementalAttributesMapper * @since 1.3.2 + * @see DefaultIncrementalAttributesMapper */ class RangeOption implements Comparable { diff --git a/core/src/main/java/org/springframework/ldap/core/support/SingleContextSource.java b/core/src/main/java/org/springframework/ldap/core/support/SingleContextSource.java index 68c4f74b..29e7ea90 100644 --- a/core/src/main/java/org/springframework/ldap/core/support/SingleContextSource.java +++ b/core/src/main/java/org/springframework/ldap/core/support/SingleContextSource.java @@ -113,9 +113,9 @@ public class SingleContextSource implements ContextSource, DisposableBean { * @param contextSource The target ContextSource to retrieve a DirContext from. * @param callback the callback to perform the Ldap operations. * @return the result returned from the callback. + * @since 2.0 * @see #doWithSingleContext(org.springframework.ldap.core.ContextSource, * LdapOperationsCallback, boolean, boolean, boolean) - * @since 2.0 */ public static T doWithSingleContext(ContextSource contextSource, LdapOperationsCallback callback) { return doWithSingleContext(contextSource, callback, DONT_USE_READ_ONLY, DONT_IGNORE_PARTIAL_RESULT, diff --git a/core/src/main/java/org/springframework/ldap/filter/AbsoluteFalseFilter.java b/core/src/main/java/org/springframework/ldap/filter/AbsoluteFalseFilter.java index 74ac7b70..3243c5aa 100644 --- a/core/src/main/java/org/springframework/ldap/filter/AbsoluteFalseFilter.java +++ b/core/src/main/java/org/springframework/ldap/filter/AbsoluteFalseFilter.java @@ -20,8 +20,8 @@ package org.springframework.ldap.filter; * A filter that will always evaluate to false, as specified in RFC4526. * * @author Mattias Hellborg Arthursson - * @see RFC4526 * @since 1.3.2 + * @see RFC4526 */ public class AbsoluteFalseFilter extends AbstractFilter { diff --git a/core/src/main/java/org/springframework/ldap/filter/AbsoluteTrueFilter.java b/core/src/main/java/org/springframework/ldap/filter/AbsoluteTrueFilter.java index e68531ca..a2938877 100644 --- a/core/src/main/java/org/springframework/ldap/filter/AbsoluteTrueFilter.java +++ b/core/src/main/java/org/springframework/ldap/filter/AbsoluteTrueFilter.java @@ -20,8 +20,8 @@ package org.springframework.ldap.filter; * A filter that will always evaluate to true, as specified in RFC4526. * * @author Mattias Hellborg Arthursson - * @see RFC4526 * @since 1.3.2 + * @see RFC4526 */ public class AbsoluteTrueFilter extends AbstractFilter { diff --git a/core/src/main/java/org/springframework/ldap/filter/AndFilter.java b/core/src/main/java/org/springframework/ldap/filter/AndFilter.java index f7331d1c..39196886 100644 --- a/core/src/main/java/org/springframework/ldap/filter/AndFilter.java +++ b/core/src/main/java/org/springframework/ldap/filter/AndFilter.java @@ -28,9 +28,9 @@ package org.springframework.ldap.filter; * * would result in: (&(objectclass=person)(cn=Some CN)) * - * @see org.springframework.ldap.filter.EqualsFilter * @author Adam Skogman * @author Mattias Hellborg Arthursson + * @see org.springframework.ldap.filter.EqualsFilter */ public class AndFilter extends BinaryLogicalFilter { diff --git a/core/src/main/java/org/springframework/ldap/pool2/DelegatingContext.java b/core/src/main/java/org/springframework/ldap/pool2/DelegatingContext.java index 8f13a551..0890af12 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/DelegatingContext.java +++ b/core/src/main/java/org/springframework/ldap/pool2/DelegatingContext.java @@ -36,8 +36,8 @@ import org.springframework.util.Assert; * to the underlying context, retains a reference to the pool the context was checked out * from and returns itself to the pool when {@link #close()} is called. * - * @since 2.0 * @author Eric Dalquist + * @since 2.0 */ public class DelegatingContext implements Context { diff --git a/core/src/main/java/org/springframework/ldap/pool2/DelegatingDirContext.java b/core/src/main/java/org/springframework/ldap/pool2/DelegatingDirContext.java index 85f8d7d9..7dd8f792 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/DelegatingDirContext.java +++ b/core/src/main/java/org/springframework/ldap/pool2/DelegatingDirContext.java @@ -37,9 +37,9 @@ import org.springframework.util.Assert; * methods to the underlying context. This class extends {@link DelegatingContext} which * handles returning the context to the pool on a call to {@link #close()} * - * @since 2.0 * @author Eric Dalquist * @author Anindya Chatterjee + * @since 2.0 */ public class DelegatingDirContext extends DelegatingContext implements DirContext, DirContextProxy { diff --git a/core/src/main/java/org/springframework/ldap/pool2/DelegatingLdapContext.java b/core/src/main/java/org/springframework/ldap/pool2/DelegatingLdapContext.java index eee9cf0e..39d1401a 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/DelegatingLdapContext.java +++ b/core/src/main/java/org/springframework/ldap/pool2/DelegatingLdapContext.java @@ -33,9 +33,9 @@ import org.springframework.util.Assert; * methods to the underlying context. This class extends {@link DelegatingDirContext} * which handles returning the context to the pool on a call to {@link #close()} * - * @since 2.0 * @author Eric Dalquist * @author Anindya Chatterjee + * @since 2.0 */ public class DelegatingLdapContext extends DelegatingDirContext implements LdapContext { diff --git a/core/src/main/java/org/springframework/ldap/pool2/MutableDelegatingLdapContext.java b/core/src/main/java/org/springframework/ldap/pool2/MutableDelegatingLdapContext.java index c5a0b60c..e53f0fc1 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/MutableDelegatingLdapContext.java +++ b/core/src/main/java/org/springframework/ldap/pool2/MutableDelegatingLdapContext.java @@ -31,9 +31,9 @@ import org.springframework.ldap.pool2.factory.MutablePooledContextSource; * context. This enables the Spring LDAP pooling to be used for scenarios such as paged * results. * - * @since 2.0 * @author Ulrik Sandberg * @author Anindya Chatterjee + * @since 2.0 */ public class MutableDelegatingLdapContext extends DelegatingLdapContext { diff --git a/core/src/main/java/org/springframework/ldap/pool2/factory/DirContextPoolableObjectFactory.java b/core/src/main/java/org/springframework/ldap/pool2/factory/DirContextPoolableObjectFactory.java index 67718ed4..ffe980eb 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/factory/DirContextPoolableObjectFactory.java +++ b/core/src/main/java/org/springframework/ldap/pool2/factory/DirContextPoolableObjectFactory.java @@ -74,11 +74,11 @@ import org.springframework.util.Assert; * * * - * @since 2.0 * @author Eric Dalquist * eric.dalquist@doit.wisc.edu * @author Mattias Hellborg Arthursson * @author Anindya Chatterjee + * @since 2.0 */ class DirContextPooledObjectFactory extends BaseKeyedPooledObjectFactory { diff --git a/core/src/main/java/org/springframework/ldap/pool2/factory/MutablePooledContextSource.java b/core/src/main/java/org/springframework/ldap/pool2/factory/MutablePooledContextSource.java index ff702afc..b5ce6f1c 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/factory/MutablePooledContextSource.java +++ b/core/src/main/java/org/springframework/ldap/pool2/factory/MutablePooledContextSource.java @@ -29,8 +29,8 @@ import org.springframework.ldap.pool2.MutableDelegatingLdapContext; * {@link MutableDelegatingLdapContext} instances. This enables the Spring LDAP pooling to * be used in scenarios that require request controls to be set, such as paged results. * - * @since 2.0 * @author Anindya Chatterjee + * @since 2.0 */ public class MutablePooledContextSource extends PooledContextSource { diff --git a/core/src/main/java/org/springframework/ldap/pool2/factory/PooledContextSource.java b/core/src/main/java/org/springframework/ldap/pool2/factory/PooledContextSource.java index 20a83368..0fcc2ba1 100644 --- a/core/src/main/java/org/springframework/ldap/pool2/factory/PooledContextSource.java +++ b/core/src/main/java/org/springframework/ldap/pool2/factory/PooledContextSource.java @@ -74,9 +74,9 @@ import org.springframework.ldap.pool2.validation.DirContextValidator; * * * - * @since 2.0 * @author Eric Dalquist * @author Anindya Chatterjee + * @since 2.0 */ public class PooledContextSource extends DelegatingBaseLdapPathContextSourceSupport implements ContextSource, DisposableBean { diff --git a/core/src/main/java/org/springframework/ldap/query/ConditionCriteria.java b/core/src/main/java/org/springframework/ldap/query/ConditionCriteria.java index e11de397..bd5c026e 100644 --- a/core/src/main/java/org/springframework/ldap/query/ConditionCriteria.java +++ b/core/src/main/java/org/springframework/ldap/query/ConditionCriteria.java @@ -21,10 +21,10 @@ package org.springframework.ldap.query; * builder step. * * @author Mattias Hellborg Arthursson + * @since 2.0 * @see LdapQueryBuilder#where(String) * @see ContainerCriteria#and(String) * @see ContainerCriteria#or(String) - * @since 2.0 */ public interface ConditionCriteria { diff --git a/core/src/main/java/org/springframework/ldap/support/LdapUtils.java b/core/src/main/java/org/springframework/ldap/support/LdapUtils.java index 937ba0a8..cc92853e 100644 --- a/core/src/main/java/org/springframework/ldap/support/LdapUtils.java +++ b/core/src/main/java/org/springframework/ldap/support/LdapUtils.java @@ -665,8 +665,8 @@ public final class LdapUtils { * >here. * @param string SID in readable format * @return Binary version of the given sid - * @see LdapUtils#convertBinarySidToString(byte[]) * @since 1.3.1 + * @see LdapUtils#convertBinarySidToString(byte[]) */ public static byte[] convertStringSidToBinary(String string) { String[] parts = string.split("-"); diff --git a/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManager.java b/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManager.java index 2dc3a9b8..30bca18d 100644 --- a/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManager.java +++ b/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManager.java @@ -93,12 +93,12 @@ import org.springframework.transaction.support.DefaultTransactionStatus; *

* * @author Mattias Hellborg Arthursson + * @since 1.2 * @see ContextSourceAndDataSourceTransactionManager * @see ContextSourceTransactionManagerDelegate * @see DefaultCompensatingTransactionOperationManager * @see TempEntryRenamingStrategy * @see TransactionAwareContextSourceProxy - * @since 1.2 */ public class ContextSourceTransactionManager extends AbstractPlatformTransactionManager implements InitializingBean { diff --git a/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManagerDelegate.java b/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManagerDelegate.java index 2b932064..2408dc7e 100644 --- a/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManagerDelegate.java +++ b/core/src/main/java/org/springframework/ldap/transaction/compensating/manager/ContextSourceTransactionManagerDelegate.java @@ -38,9 +38,9 @@ import org.springframework.util.Assert; * part in {@link ContextSourceAndDataSourceTransactionManager}. * * @author Mattias Hellborg Arthursson + * @since 1.2 * @see ContextSourceTransactionManager * @see ContextSourceAndDataSourceTransactionManager - * @since 1.2 */ public class ContextSourceTransactionManagerDelegate extends AbstractCompensatingTransactionManagerDelegate { diff --git a/core/src/main/java/org/springframework/transaction/compensating/CompensatingTransactionOperationFactory.java b/core/src/main/java/org/springframework/transaction/compensating/CompensatingTransactionOperationFactory.java index 7fdf6b87..ed227a26 100644 --- a/core/src/main/java/org/springframework/transaction/compensating/CompensatingTransactionOperationFactory.java +++ b/core/src/main/java/org/springframework/transaction/compensating/CompensatingTransactionOperationFactory.java @@ -23,8 +23,8 @@ import org.springframework.transaction.compensating.support.DefaultCompensatingT * based on operation method names. * * @author Mattias Hellborg Arthursson - * @see DefaultCompensatingTransactionOperationManager * @since 1.2 + * @see DefaultCompensatingTransactionOperationManager */ public interface CompensatingTransactionOperationFactory {