Align JavaDoc Formatting in Core

Closes gh-748
This commit is contained in:
Josh Cummings
2023-05-09 13:01:29 -06:00
parent f56a6e71f6
commit cc2560ef19
34 changed files with 48 additions and 48 deletions

View File

@@ -32,10 +32,10 @@ import javax.naming.directory.Attributes;
* <p>
* 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<T> {

View File

@@ -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<T> implements NameClassPairCallbackHandler {

View File

@@ -32,9 +32,9 @@ import javax.naming.directory.DirContext;
* };
* </pre>
*
* @author Mattias Hellborg Arthursson
* @see LdapTemplate#executeReadOnly(ContextExecutor)
* @see LdapTemplate#executeReadWrite(ContextExecutor)
* @author Mattias Hellborg Arthursson
*/
public interface ContextExecutor<T> {

View File

@@ -38,6 +38,7 @@ import org.springframework.ldap.core.support.DefaultDirObjectFactory;
* <p>
* 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<T> {

View File

@@ -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 {

View File

@@ -82,6 +82,10 @@ import org.springframework.util.StringUtils;
* UnsupportOperationException.
* </p>
*
* @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 {

View File

@@ -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 {

View File

@@ -1058,9 +1058,9 @@ public interface LdapOperations {
* registered with the <code>ContextSource</code>, 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 <code>ContextSource</code>, 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 <code>true</code> if the authentication was successful, <code>false</code>
* 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 <code>true</code> if the authentication was successful, <code>false</code>
* 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 <code>true</code> if the authentication was successful, <code>false</code>
* 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 <code>true</code> if the authentication was successful, <code>false</code>
* 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 <code>true</code> if the authentication was successful, <code>false</code>
* 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);

View File

@@ -72,9 +72,9 @@ import org.springframework.util.CollectionUtils;
* Neither is there any simple way to get notified that a
* <code>PartialResultException</code> 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 {

View File

@@ -32,9 +32,9 @@ import javax.naming.directory.DirContext;
* }
* </pre>
*
* @author Mattias Hellborg Arthursson
* @see org.springframework.ldap.core.LdapTemplate#search(SearchExecutor,
* NameClassPairCallbackHandler)
* @author Mattias Hellborg Arthursson
*/
public interface SearchExecutor {

View File

@@ -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 {

View File

@@ -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
* <code>Ordered.LOWEST_PRECEDENCE</code>.
* @see Ordered
* @since 1.3.2
* @see Ordered
*/
public void setOrder(int order) {
this.order = order;

View File

@@ -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 {

View File

@@ -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 <T> return type of the
* {@link #mapFromContextWithControls(Object, javax.naming.ldap.HasControls)} method
* @author Tim Terry
* @author Ulrik Sandberg
*/
public interface ContextMapperWithControls<T> extends ContextMapper<T> {

View File

@@ -68,13 +68,13 @@ import org.springframework.ldap.support.LdapUtils;
*
* @author Marius Scurtescu
* @author Mattias Hellborg Arthursson
* @since 1.3.2
* @see <a href="https://tools.ietf.org/html/draft-kashi-incremental-00">Incremental
* Retrieval of Multi-valued Properties</a>
* @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<DefaultIncrementalAttributesMapper> {

View File

@@ -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 {

View File

@@ -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 {

View File

@@ -24,8 +24,8 @@ import java.util.regex.Pattern;
* Properties</em>.
*
* @author Marius Scurtescu
* @see DefaultIncrementalAttributesMapper
* @since 1.3.2
* @see DefaultIncrementalAttributesMapper
*/
class RangeOption implements Comparable<RangeOption> {

View File

@@ -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> T doWithSingleContext(ContextSource contextSource, LdapOperationsCallback<T> callback) {
return doWithSingleContext(contextSource, callback, DONT_USE_READ_ONLY, DONT_IGNORE_PARTIAL_RESULT,

View File

@@ -20,8 +20,8 @@ package org.springframework.ldap.filter;
* A filter that will always evaluate to <code>false</code>, as specified in RFC4526.
*
* @author Mattias Hellborg Arthursson
* @see <a href="https://tools.ietf.org/html/rfc4526">RFC4526</a>
* @since 1.3.2
* @see <a href="https://tools.ietf.org/html/rfc4526">RFC4526</a>
*/
public class AbsoluteFalseFilter extends AbstractFilter {

View File

@@ -20,8 +20,8 @@ package org.springframework.ldap.filter;
* A filter that will always evaluate to <code>true</code>, as specified in RFC4526.
*
* @author Mattias Hellborg Arthursson
* @see <a href="https://tools.ietf.org/html/rfc4526">RFC4526</a>
* @since 1.3.2
* @see <a href="https://tools.ietf.org/html/rfc4526">RFC4526</a>
*/
public class AbsoluteTrueFilter extends AbstractFilter {

View File

@@ -28,9 +28,9 @@ package org.springframework.ldap.filter;
*
* would result in: <code>(&amp;(objectclass=person)(cn=Some CN))</code>
*
* @see org.springframework.ldap.filter.EqualsFilter
* @author Adam Skogman
* @author Mattias Hellborg Arthursson
* @see org.springframework.ldap.filter.EqualsFilter
*/
public class AndFilter extends BinaryLogicalFilter {

View File

@@ -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 {

View File

@@ -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 {

View File

@@ -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 {

View File

@@ -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 {

View File

@@ -74,11 +74,11 @@ import org.springframework.util.Assert;
* </tr>
* </table>
*
* @since 2.0
* @author Eric Dalquist
* <a href="mailto:eric.dalquist@doit.wisc.edu">eric.dalquist@doit.wisc.edu</a>
* @author Mattias Hellborg Arthursson
* @author Anindya Chatterjee
* @since 2.0
*/
class DirContextPooledObjectFactory extends BaseKeyedPooledObjectFactory<Object, Object> {

View File

@@ -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 {

View File

@@ -74,9 +74,9 @@ import org.springframework.ldap.pool2.validation.DirContextValidator;
* </tr>
* </table>
*
* @since 2.0
* @author Eric Dalquist
* @author Anindya Chatterjee
* @since 2.0
*/
public class PooledContextSource extends DelegatingBaseLdapPathContextSourceSupport
implements ContextSource, DisposableBean {

View File

@@ -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 {

View File

@@ -665,8 +665,8 @@ public final class LdapUtils {
* >here</a>.
* @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("-");

View File

@@ -93,12 +93,12 @@ import org.springframework.transaction.support.DefaultTransactionStatus;
* <p>
*
* @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 {

View File

@@ -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 {

View File

@@ -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 {