Reviewed javadoc.

This commit is contained in:
Ulrik Sandberg
2007-09-10 10:48:38 +00:00
parent 4325f15d9c
commit a7d5d1b453
48 changed files with 43 additions and 103 deletions

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the AttributeInUseException.
* Runtime exception mirroring the JNDI AttributeInUseException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the AttributeModificationException.
* Runtime exception mirroring the JNDI AttributeModificationException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the AuthenticationException.
* Runtime exception mirroring the JNDI AuthenticationException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the AuthenticationNotSupportedException.
* Runtime exception mirroring the JNDI AuthenticationNotSupportedException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the CannotProceedException.
* Runtime exception mirroring the JNDI CannotProceedException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the CommunicationException.
* Runtime exception mirroring the JNDI CommunicationException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the ConfigurationException.
* Runtime exception mirroring the JNDI ConfigurationException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the ContextNotEmptyException.
* Runtime exception mirroring the JNDI ContextNotEmptyException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InsufficientResourcesException.
* Runtime exception mirroring the JNDI InsufficientResourcesException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InterruptedNamingException.
* Runtime exception mirroring the JNDI InterruptedNamingException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InvalidAttributeIdentifierException.
* Runtime exception mirroring the JNDI InvalidAttributeIdentifierException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InvalidAttributeValueException.
* Runtime exception mirroring the JNDI InvalidAttributeValueException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InvalidAttributesException.
* Runtime exception mirroring the JNDI InvalidAttributesException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InvalidNameException.
* Runtime exception mirroring the JNDI InvalidNameException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InvalidSearchControlsException.
* Runtime exception mirroring the JNDI InvalidSearchControlsException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the InvalidSearchFilterException.
* Runtime exception mirroring the JNDI InvalidSearchFilterException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the LdapReferralException.
* Runtime exception mirroring the JNDI LdapReferralException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the LimitExceededException.
* Runtime exception mirroring the JNDI LimitExceededException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the LinkException.
* Runtime exception mirroring the JNDI LinkException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the LinkLoopException.
* Runtime exception mirroring the JNDI LinkLoopException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the MalformedLinkException.
* Runtime exception mirroring the JNDI MalformedLinkException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NameAlreadyBoundException.
* Runtime exception mirroring the JNDI NameAlreadyBoundException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NameNotFoundException.
* Runtime exception mirroring the JNDI NameNotFoundException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -31,8 +31,7 @@ import org.springframework.core.NestedRuntimeException;
* @author Ulrik Sandberg
* @since 1.2
*/
public abstract class NamingException extends NestedRuntimeException implements
Serializable {
public abstract class NamingException extends NestedRuntimeException {
private Throwable cause;

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NamingSecurityException.
* Runtime exception mirroring the JNDI NamingSecurityException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NoInitialContextException.
* Runtime exception mirroring the JNDI NoInitialContextException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NoPermissionException.
* Runtime exception mirroring the JNDI NoPermissionException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NoSuchAttributeException.
* Runtime exception mirroring the JNDI NoSuchAttributeException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the NotContextException.
* Runtime exception mirroring the JNDI NotContextException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the OperationNotSupportedException.
* Runtime exception mirroring the JNDI OperationNotSupportedException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the PartialResultException.
* Runtime exception mirroring the JNDI PartialResultException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the ReferralException.
* Runtime exception mirroring the JNDI ReferralException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the SchemaViolationException.
* Runtime exception mirroring the JNDI SchemaViolationException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the ServiceUnavailableException.
* Runtime exception mirroring the JNDI ServiceUnavailableException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the SizeLimitExceededException.
* Runtime exception mirroring the JNDI SizeLimitExceededException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -17,7 +17,7 @@
package org.springframework.ldap;
/**
* Runtime exception mirroring the TimeLimitExceededException.
* Runtime exception mirroring the JNDI TimeLimitExceededException.
*
* @author Ulrik Sandberg
* @since 1.2

View File

@@ -23,10 +23,9 @@ import org.springframework.transaction.compensating.CompensatingTransactionOpera
import org.springframework.transaction.compensating.CompensatingTransactionOperationRecorder;
/**
* A {@link CompensatingTransactionOperationRecorder} to manage LDAP bind
* operations. The corresponding
* {@link CompensatingTransactionOperationExecutor} is
* {@link BindOperationExecutor}.
* A {@link CompensatingTransactionOperationRecorder} keeping track of bind
* operations. Creates {@link BindOperationExecutor} objects in
* {@link #recordOperation(Object[])}.
*
* @author Mattias Arthursson
* @since 1.2
@@ -48,8 +47,6 @@ public class BindOperationRecorder implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationRecorder#recordOperation(java.lang.Object[])
*/
public CompensatingTransactionOperationExecutor recordOperation(
@@ -79,5 +76,4 @@ public class BindOperationRecorder implements
LdapOperations getLdapOperations() {
return ldapOperations;
}
}

View File

@@ -60,8 +60,6 @@ public class LdapCompensatingTransactionOperationFactory implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.transaction.compensating.CompensatingTransactionOperationFactory#createRecordingOperation(java.lang.Object,
* java.lang.String)
*/
@@ -125,8 +123,6 @@ public class LdapCompensatingTransactionOperationFactory implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.ContextSource#getReadOnlyContext()
*/
public DirContext getReadOnlyContext() throws NamingException {
@@ -134,8 +130,6 @@ public class LdapCompensatingTransactionOperationFactory implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.ContextSource#getReadWriteContext()
*/
public DirContext getReadWriteContext() throws NamingException {
@@ -169,8 +163,6 @@ public class LdapCompensatingTransactionOperationFactory implements
}
/*
* (non-Javadoc)
*
* @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object,
* java.lang.reflect.Method, java.lang.Object[])
*/

View File

@@ -70,8 +70,6 @@ public class ModifyAttributesOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#rollback()
*/
public void rollback() {
@@ -86,8 +84,6 @@ public class ModifyAttributesOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#commit()
*/
public void commit() {
@@ -95,8 +91,6 @@ public class ModifyAttributesOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#performOperation()
*/
public void performOperation() {
@@ -119,5 +113,4 @@ public class ModifyAttributesOperationExecutor implements
ModificationItem[] getCompensatingModifications() {
return compensatingModifications;
}
}

View File

@@ -50,8 +50,6 @@ public class ModifyAttributesOperationRecorder implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationRecorder#recordOperation(java.lang.Object[])
*/
public CompensatingTransactionOperationExecutor recordOperation(

View File

@@ -31,8 +31,6 @@ public class NullOperationExecutor implements
private static Log log = LogFactory.getLog(NullOperationExecutor.class);
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#rollback()
*/
public void rollback() {
@@ -46,5 +44,4 @@ public class NullOperationExecutor implements
public void performOperation() {
log.info("Performing null operation");
}
}

View File

@@ -23,8 +23,9 @@ import org.springframework.transaction.compensating.CompensatingTransactionOpera
* A {@link CompensatingTransactionOperationRecorder} performing nothing,
* returning a {@link NullOperationExecutor} regardless of the input. Instances
* of this class will be created if the
* {@link CompensatingTransactionOperationManager} cannot determine any appropriate
* {@link CompensatingTransactionOperationRecorder} for the current operation.
* {@link CompensatingTransactionOperationManager} cannot determine any
* appropriate {@link CompensatingTransactionOperationRecorder} for the current
* operation.
*
* @author Mattias Arthursson
* @since 1.2
@@ -33,13 +34,10 @@ public class NullOperationRecorder implements
CompensatingTransactionOperationRecorder {
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationRecorder#recordOperation(java.lang.Object[])
*/
public CompensatingTransactionOperationExecutor recordOperation(
Object[] args) {
return new NullOperationExecutor();
}
}

View File

@@ -85,8 +85,6 @@ public class RebindOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#rollback()
*/
public void rollback() {
@@ -101,8 +99,6 @@ public class RebindOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#commit()
*/
public void commit() {
@@ -111,8 +107,6 @@ public class RebindOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#performOperation()
*/
public void performOperation() {
@@ -138,5 +132,4 @@ public class RebindOperationExecutor implements
Name getTemporaryDn() {
return temporaryDn;
}
}

View File

@@ -54,8 +54,6 @@ public class RebindOperationRecorder implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationRecorder#recordOperation(java.lang.Object[])
*/
public CompensatingTransactionOperationExecutor recordOperation(

View File

@@ -60,8 +60,6 @@ public class RenameOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#rollback()
*/
public void rollback() {
@@ -75,8 +73,6 @@ public class RenameOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#commit()
*/
public void commit() {
@@ -84,8 +80,6 @@ public class RenameOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#performOperation()
*/
public void performOperation() {
@@ -104,5 +98,4 @@ public class RenameOperationExecutor implements
Name getOriginalDn() {
return originalDn;
}
}

View File

@@ -26,7 +26,7 @@ import org.springframework.util.Assert;
/**
* A {@link CompensatingTransactionOperationRecorder} for keeping track of
* rename operations. Creates {@link RebindOperationExecutor} objects for
* rename operations. Creates {@link RenameOperationExecutor} objects for
* rolling back.
*
* @author Mattias Arthursson
@@ -51,8 +51,6 @@ public class RenameOperationRecorder implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationRecorder#recordOperation(java.lang.Object[])
*/
public CompensatingTransactionOperationExecutor recordOperation(
@@ -71,5 +69,4 @@ public class RenameOperationRecorder implements
LdapOperations getLdapOperations() {
return ldapOperations;
}
}

View File

@@ -64,8 +64,6 @@ public class UnbindOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#rollback()
*/
public void rollback() {
@@ -78,13 +76,6 @@ public class UnbindOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#commit()
*/
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#commit()
*/
public void commit() {
@@ -93,8 +84,6 @@ public class UnbindOperationExecutor implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationExecutor#performOperation()
*/
public void performOperation() {
@@ -114,5 +103,4 @@ public class UnbindOperationExecutor implements
Name getTemporaryDn() {
return temporaryDn;
}
}

View File

@@ -54,8 +54,6 @@ public class UnbindOperationRecorder implements
}
/*
* (non-Javadoc)
*
* @see org.springframework.ldap.support.transaction.CompensatingTransactionOperationRecorder#recordOperation(java.lang.Object[])
*/
public CompensatingTransactionOperationExecutor recordOperation(