DATACMNS-1085 - Fixed typos in Javadoc.

Original pull request: #229.
This commit is contained in:
Oliver Gierke
2017-07-24 10:32:19 +02:00
parent aa9cfc60ef
commit 3503f37fb8
12 changed files with 19 additions and 18 deletions

View File

@@ -80,7 +80,7 @@ public class UserCredentials {
}
/**
* Returns the password in obfuscated fashion which means everthing except the first and last character replaced by
* Returns the password in obfuscated fashion which means everything except the first and last character replaced by
* stars. If the password is one or two characters long we'll obfuscate it entirely.
*
* @return the obfuscated password

View File

@@ -106,7 +106,7 @@ public class TypeFilterParser {
}
/**
* Createsa a {@link TypeFilter} instance from the given {@link Element} and {@link ClassLoader}.
* Creates a {@link TypeFilter} instance from the given {@link Element} and {@link ClassLoader}.
*
* @param element must not be {@literal null}.
* @param classLoader must not be {@literal null}.
@@ -171,8 +171,8 @@ public class TypeFilterParser {
Class<?> filterClass = classLoader.loadClass(expression);
if (!TypeFilter.class.isAssignableFrom(filterClass)) {
throw new IllegalArgumentException("Class is not assignable to [" + TypeFilter.class.getName() + "]: "
+ expression);
throw new IllegalArgumentException(
"Class is not assignable to [" + TypeFilter.class.getName() + "]: " + expression);
}
return (TypeFilter) BeanUtils.instantiateClass(filterClass);
}

View File

@@ -30,9 +30,10 @@ public enum Metrics implements Metric {
private final String abbreviation;
/**
* Creates a new {@link Metrics} using the given muliplier.
* Creates a new {@link Metrics} using the given multiplier.
*
* @param multiplier the earth radius at equator.
* @param multiplier the earth radius at equator, must not be {@literal null}.
* @param abbreviation the abbreviation to use for this {@link Metric}, must not be {@literal null}.
*/
private Metrics(double multiplier, String abbreviation) {

View File

@@ -99,7 +99,7 @@ public interface QueryDslPredicateExecutor<T> {
/**
* Checks whether the data store contains elements that match the given {@link Predicate}.
*
* @param predicate the {@link Predicate} to use for the existance check, can be {@literal null}.
* @param predicate the {@link Predicate} to use for the existence check, can be {@literal null}.
* @return {@literal true} if the data store contains elements that match the given {@link Predicate}.
*/
boolean exists(Predicate predicate);

View File

@@ -33,7 +33,7 @@ import java.lang.annotation.Target;
public @interface QuerydslPredicate {
/**
* The root type to create the {@link com.mysema.query.types.Predicate}. Specify this explictly if the type is not
* The root type to create the {@link com.mysema.query.types.Predicate}. Specify this explicitly if the type is not
* contained in the controller method's return type.
*
* @return

View File

@@ -31,10 +31,10 @@ import org.springframework.data.repository.PagingAndSortingRepository;
public interface CrudMethods {
/**
* Returns the method to be used for saving entities. Usually siganture compatible to
* Returns the method to be used for saving entities. Usually signature compatible to
* {@link CrudRepository#save(Object)}.
*
* @return the method to save entities or {@literal null} if noen exposed.
* @return the method to save entities or {@literal null} if none exposed.
* @see #hasSaveMethod()
*/
Method getSaveMethod();
@@ -47,7 +47,7 @@ public interface CrudMethods {
boolean hasSaveMethod();
/**
* Returns the find all method of the repository. Implementations should prefer more detailled methods like
* Returns the find all method of the repository. Implementations should prefer more detailed methods like
* {@link PagingAndSortingRepository}'s taking a {@link Pageable} or {@link Sort} instance.
*
* @return the find all method of the repository or {@literal null} if not available.
@@ -87,7 +87,7 @@ public interface CrudMethods {
Method getDeleteMethod();
/**
* Returns whether the repository esposes a delete method.
* Returns whether the repository exposes a delete method.
*
* @return
*/

View File

@@ -57,7 +57,7 @@ public abstract class AbstractRepositoryMetadata implements RepositoryMetadata {
}
/**
* Creates a new {@link RepositoryMetadata} for the given repsository interface.
* Creates a new {@link RepositoryMetadata} for the given repository interface.
*
* @param repositoryInterface must not be {@literal null}.
* @since 1.9

View File

@@ -59,7 +59,7 @@ public class ResourceReaderRepositoryPopulator implements RepositoryPopulator, A
}
/**
* Createsa a new {@link ResourceReaderRepositoryPopulator} using the given {@link ResourceReader} and
* Creates a new {@link ResourceReaderRepositoryPopulator} using the given {@link ResourceReader} and
* {@link ClassLoader}.
*
* @param reader must not be {@literal null}.

View File

@@ -83,7 +83,7 @@ public class QueryMethod {
if (hasParameterOfType(method, Sort.class)) {
throw new IllegalStateException(String.format("Method must not have Pageable *and* Sort parameter. "
+ "Use sorting capabilities on Pageble instead! Offending method: %s", method.toString()));
+ "Use sorting capabilities on Pageable instead! Offending method: %s", method.toString()));
}
}

View File

@@ -65,7 +65,7 @@ public class Part {
*/
public Part(String source, Class<?> clazz, boolean alwaysIgnoreCase) {
Assert.hasText(source, "Part source must not be null or emtpy!");
Assert.hasText(source, "Part source must not be null or empty!");
Assert.notNull(clazz, "Type must not be null!");
String partToUse = detectAndSetIgnoreCase(source);

View File

@@ -48,7 +48,7 @@ public class NullableWrapper {
}
/**
* Returns the backing valie
* Returns the backing value.
*
* @return the value can be {@literal null}.
*/

View File

@@ -177,7 +177,7 @@ public class PageableHandlerMethodArgumentResolver implements HandlerMethodArgum
* The delimiter to be used between the qualifier and the actual page number and size properties. Defaults to
* {@code _}. So a qualifier of {@code foo} will result in a page number parameter of {@code foo_page}.
*
* @param qualifierDelimiter the delimter to be used or {@literal null} to reset to the default.
* @param qualifierDelimiter the delimiter to be used or {@literal null} to reset to the default.
*/
public void setQualifierDelimiter(String qualifierDelimiter) {
this.qualifierDelimiter = qualifierDelimiter == null ? DEFAULT_QUALIFIER_DELIMITER : qualifierDelimiter;