DATAJDBC-199 - Fix @since JavaDoc comments.

This commit is contained in:
Jens Schauder
2018-04-12 16:32:25 +02:00
parent 5382d3b94e
commit 3f89062bc1
64 changed files with 65 additions and 27 deletions

View File

@@ -29,6 +29,7 @@ import org.springframework.data.mapping.PropertyPath;
* not throw an exception.
*
* @author Jens Schauder
* @since 1.0
*/
public class CascadingDataAccessStrategy implements DataAccessStrategy {

View File

@@ -24,6 +24,7 @@ import org.springframework.data.mapping.PropertyPath;
* Abstraction for accesses to the database that should be implementable with a single SQL statement and relates to a single entity as opposed to {@link JdbcEntityOperations} which provides interactions related to complete aggregates.
*
* @author Jens Schauder
* @since 1.0
*/
public interface DataAccessStrategy {

View File

@@ -44,6 +44,7 @@ import org.springframework.util.Assert;
* The default {@link DataAccessStrategy} is to generate SQL statements based on meta data from the entity.
*
* @author Jens Schauder
* @since 1.0
*/
public class DefaultDataAccessStrategy implements DataAccessStrategy {

View File

@@ -34,6 +34,7 @@ import org.springframework.util.Assert;
* interactions.
*
* @author Jens Schauder
* @since 1.0
*/
class DefaultJdbcInterpreter implements Interpreter {

View File

@@ -26,6 +26,7 @@ import org.springframework.util.Assert;
* cyclical dependencies.
*
* @author Jens Schauder
* @since 1.0
*/
public class DelegatingDataAccessStrategy implements DataAccessStrategy {

View File

@@ -43,7 +43,7 @@ import org.springframework.util.Assert;
*
* @author Jens Schauder
* @author Oliver Gierke
* @since 2.0
* @since 1.0
*/
public class EntityRowMapper<T> implements RowMapper<T> {

View File

@@ -34,6 +34,7 @@ import org.springframework.dao.DataAccessException;
* exceptions this {@link Collector} throws itself an exception, gathering all exceptions thrown.
*
* @author Jens Schauder
* @since 1.0
*/
class FunctionCollector<T> implements Collector<DataAccessStrategy, FunctionCollector<T>.ResultOrException, T> {

View File

@@ -29,6 +29,7 @@ import java.util.Map.Entry;
* A converter for creating a {@link Map} from an {@link Iterable<Map.Entry>}.
*
* @author Jens Schauder
* @since 1.0
*/
class IterableOfEntryToMapConverter implements ConditionalConverter, Converter<Iterable, Map> {

View File

@@ -19,6 +19,7 @@ package org.springframework.data.jdbc.core;
* Specifies a operations one can perform on a database, based on an <em>Domain Type</em>.
*
* @author Jens Schauder
* @since 1.0
*/
public interface JdbcEntityOperations {

View File

@@ -38,6 +38,7 @@ import org.springframework.data.jdbc.mapping.model.JdbcPersistentEntityInformati
*
* @author Jens Schauder
* @author Mark Paluch
* @since 1.0
*/
public class JdbcEntityTemplate implements JdbcEntityOperations {

View File

@@ -29,6 +29,7 @@ import org.springframework.lang.Nullable;
* {@link Map.Entry} is delegated to a {@link RowMapper} provided in the constructor.
*
* @author Jens Schauder
* @since 1.0
*/
class MapEntityRowMapper<T> implements RowMapper<Map.Entry<Object, T>> {

View File

@@ -27,6 +27,7 @@ import java.util.stream.Collectors;
* {@link JdbcEntityTemplate}.
*
* @author Jens Schauder
* @since 1.0
*/
class SelectBuilder {

View File

@@ -38,7 +38,7 @@ import java.util.stream.Stream;
* Generates SQL statements to be used by {@link SimpleJdbcRepository}
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
class SqlGenerator {

View File

@@ -27,6 +27,7 @@ import org.springframework.data.jdbc.mapping.model.JdbcMappingContext;
* type, the same generator will get returned.
*
* @author Jens Schauder
* @since 1.0
*/
@RequiredArgsConstructor
public class SqlGeneratorSource {

View File

@@ -21,7 +21,7 @@ import org.springframework.dao.NonTransientDataAccessException;
* Signals failure to set the id property of an entity.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class UnableToSetId extends NonTransientDataAccessException {

View File

@@ -25,6 +25,7 @@ import java.util.List;
* Represents the change happening to the aggregate (as used in the context of Domain Driven Design) as a whole.
*
* @author Jens Schauder
* @since 1.0
*/
@RequiredArgsConstructor
@Getter

View File

@@ -27,6 +27,7 @@ import org.springframework.util.Assert;
* Abstracts over a single interaction with a database.
*
* @author Jens Schauder
* @since 1.0
*/
@ToString
@Getter

View File

@@ -20,6 +20,7 @@ package org.springframework.data.jdbc.core.conversion;
* context information about the action and the entity.
*
* @author Jens Schauder
* @since 1.0
*/
public class DbActionExecutionException extends RuntimeException {
public DbActionExecutionException(DbAction<?> action, Throwable cause) {

View File

@@ -22,6 +22,7 @@ import org.springframework.data.jdbc.core.conversion.DbAction.Update;
/**
* @author Jens Schauder
* @since 1.0
*/
public interface Interpreter {

View File

@@ -22,6 +22,7 @@ import org.springframework.data.jdbc.mapping.model.JdbcMappingContext;
* executed against the database to recreate the appropriate state in the database.
*
* @author Jens Schauder
* @since 1.0
*/
public class JdbcEntityDeleteWriter extends JdbcEntityWriterSupport {

View File

@@ -39,6 +39,7 @@ import org.springframework.util.ClassUtils;
* executed against the database to recreate the appropriate state in the database.
*
* @author Jens Schauder
* @since 1.0
*/
public class JdbcEntityWriter extends JdbcEntityWriterSupport {

View File

@@ -22,6 +22,7 @@ import org.springframework.data.jdbc.mapping.model.JdbcMappingContext;
* Common infrastructure needed by different implementations of {@link EntityWriter}<Object, AggregateChange>.
*
* @author Jens Schauder
* @since 1.0
*/
abstract class JdbcEntityWriterSupport implements EntityWriter<Object, AggregateChange> {
protected final JdbcMappingContext context;

View File

@@ -25,6 +25,7 @@ import org.springframework.util.StringUtils;
* See https://jira.spring.io/browse/DATACMNS-1204.
*
* @author Jens Schauder
* @since 1.0
*/
public class JdbcPropertyPath {

View File

@@ -25,7 +25,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* not depends on the delete method used.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class AfterDelete extends JdbcEventWithId {

View File

@@ -22,6 +22,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* postprocessing of entities.
*
* @author Jens Schauder
* @since 1.0
*/
public class AfterLoadEvent extends JdbcEventWithIdAndEntity {

View File

@@ -22,7 +22,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* Subclasses of this get published after a new instance or a changed instance was saved in the database.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class AfterSave extends JdbcEventWithIdAndEntity {

View File

@@ -24,7 +24,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* Gets published when an entity is about to get deleted.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class BeforeDelete extends JdbcEventWithId {

View File

@@ -21,7 +21,7 @@ import org.springframework.data.jdbc.core.conversion.AggregateChange;
* Subclasses of this get published before an entity gets saved to the database.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class BeforeSave extends JdbcEventWithEntity {

View File

@@ -23,7 +23,7 @@ import org.springframework.util.Assert;
* Wrapper for an identifier of an entity. Might either be a {@link Specified} or {@link Unset#UNSET}
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public interface Identifier {

View File

@@ -20,6 +20,7 @@ import java.util.Optional;
/**
*
* @author Oliver Gierke
* @since 1.0
*/
public interface JdbcEvent {

View File

@@ -23,7 +23,7 @@ import org.springframework.data.jdbc.core.conversion.AggregateChange;
* A {@link SimpleJdbcEvent} which is guaranteed to have an entity.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class JdbcEventWithEntity extends SimpleJdbcEvent implements WithEntity {

View File

@@ -24,7 +24,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* A {@link SimpleJdbcEvent} guaranteed to have an identifier.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class JdbcEventWithId extends SimpleJdbcEvent implements WithId {

View File

@@ -26,7 +26,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* A {@link SimpleJdbcEvent} which is guaranteed to have an identifier and an entity.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
@Getter
public class JdbcEventWithIdAndEntity extends JdbcEventWithId implements WithEntity {

View File

@@ -26,7 +26,7 @@ import org.springframework.data.jdbc.core.conversion.AggregateChange;
*
* @author Jens Schauder
* @author Oliver Gierke
* @since 2.0
* @since 1.0
*/
class SimpleJdbcEvent extends ApplicationEvent implements JdbcEvent {

View File

@@ -26,7 +26,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
*
* @author Jens Schauder
* @author Oliver Gierke
* @since 2.0
* @since 1.0
*/
@Value(staticConstructor = "of")
class SpecifiedIdentifier implements Specified {

View File

@@ -22,7 +22,7 @@ import java.util.Optional;
*
* @author Jens Schaude
* @author Oliver Gierke
* @since 2.0
* @since 1.0
*/
enum Unset implements Identifier {

View File

@@ -20,7 +20,7 @@ package org.springframework.data.jdbc.mapping.event;
* without going through an {@link java.util.Optional}
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public interface WithEntity extends JdbcEvent {

View File

@@ -22,7 +22,7 @@ import org.springframework.data.jdbc.mapping.event.Identifier.Specified;
* access to the {@link Specified} identifier.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public interface WithId extends JdbcEvent {

View File

@@ -21,7 +21,7 @@ import org.springframework.lang.Nullable;
/**
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class BasicJdbcPersistentEntityInformation<T, ID> extends PersistentEntityInformation<T, ID>
implements JdbcPersistentEntityInformation<T, ID> {

View File

@@ -35,7 +35,7 @@ import java.util.Set;
*
* @author Jens Schauder
* @author Greg Turnquist
* @since 2.0
* @since 1.0
*/
public class BasicJdbcPersistentProperty extends AnnotationBasedPersistentProperty<JdbcPersistentProperty>
implements JdbcPersistentProperty {

View File

@@ -19,6 +19,7 @@ import org.springframework.core.convert.support.GenericConversionService;
/**
* @author Jens Schauder
* @since 1.0
*/
public interface ConversionCustomizer {

View File

@@ -23,6 +23,7 @@ import org.springframework.data.util.ParsingUtils;
*
* @author Kazuki Shimizu
* @author Jens Schauder
* @since 1.0
*/
public class DelimiterNamingStrategy implements NamingStrategy {

View File

@@ -45,7 +45,7 @@ import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
* @author Jens Schauder
* @author Greg Turnquist
* @author Kazuki Shimizu
* @since 2.0
* @since 1.0
*/
public class JdbcMappingContext extends AbstractMappingContext<JdbcPersistentEntity<?>, JdbcPersistentProperty> {

View File

@@ -21,7 +21,7 @@ import org.springframework.data.mapping.model.MutablePersistentEntity;
/**
* @author Jens Schauder
* @author Oliver Gierke
* @since 2.0
* @since 1.0
*/
public interface JdbcPersistentEntity<T> extends MutablePersistentEntity<T, JdbcPersistentProperty> {

View File

@@ -25,7 +25,7 @@ import org.springframework.data.util.TypeInformation;
*
* @author Jens Schauder
* @author Greg Turnquist
* @since 2.0
* @since 1.0
*/
class JdbcPersistentEntityImpl<T> extends BasicPersistentEntity<T, JdbcPersistentProperty>
implements JdbcPersistentEntity<T> {

View File

@@ -19,7 +19,7 @@ import org.springframework.data.repository.core.EntityInformation;
/**
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public interface JdbcPersistentEntityInformation<T, ID> extends EntityInformation<T, ID> {

View File

@@ -22,7 +22,7 @@ import org.springframework.data.mapping.PersistentProperty;
*
* @author Jens Schauder
* @author Oliver Gierke
* @since 2.0
* @since 1.0
*/
public interface JdbcPersistentProperty extends PersistentProperty<JdbcPersistentProperty> {

View File

@@ -24,6 +24,7 @@ package org.springframework.data.jdbc.mapping.model;
*
* @author Greg Turnquist
* @author Michael Simons
* @since 1.0
*/
public interface NamingStrategy {

View File

@@ -21,7 +21,9 @@ import java.util.Map;
* {@link MyBatisContext} instances get passed to MyBatis mapped statements as arguments, making Ids, instances, domainType and other attributes available to the statements.
*
* All methods might return {@literal null} depending on the kind of values available on invocation.
*
* @author Jens Schauder
* @since 1.0
*/
public class MyBatisContext {

View File

@@ -43,6 +43,7 @@ import org.springframework.util.Assert;
*
* @author Jens Schauder
* @author Kazuki Shimizu
* @since 1.0
*/
public class MyBatisDataAccessStrategy implements DataAccessStrategy {

View File

@@ -20,6 +20,7 @@ package org.springframework.data.jdbc.mybatis;
*
* @author Kazuki Shimizu
* @author Jens Schauder
* @since 1.0
*/
public interface NamespaceStrategy {

View File

@@ -21,6 +21,7 @@ import org.springframework.jdbc.core.RowMapper;
* A map from a type to a {@link RowMapper} to be used for extracting that type from {@link java.sql.ResultSet}s.
*
* @author Jens Schauder
* @since 1.0
*/
public interface RowMapperMap {

View File

@@ -26,7 +26,7 @@ import org.springframework.data.repository.CrudRepository;
/**
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class SimpleJdbcRepository<T, ID> implements CrudRepository<T, ID> {

View File

@@ -25,6 +25,7 @@ import org.springframework.jdbc.core.RowMapper;
* A {@link RowMapperMap} that allows for registration of {@link RowMapper}s via a fluent Api.
*
* @author Jens Schauder
* @since 1.0
*/
public class ConfigurableRowMapperMap implements RowMapperMap {

View File

@@ -33,7 +33,7 @@ import org.springframework.data.jdbc.repository.support.JdbcRepositoryFactoryBea
*
* @author Jens Schauder
* @author Greg Turnquist
* @since 2.0
* @since 1.0
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)

View File

@@ -30,6 +30,7 @@ import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
*
* @author Greg Turnquist
* @author Jens Schauder
* @since 1.0
*/
@Configuration
public class JdbcConfiguration {

View File

@@ -25,7 +25,7 @@ import org.springframework.data.repository.config.RepositoryConfigurationExtensi
* {@link ImportBeanDefinitionRegistrar} to enable {@link EnableJdbcRepositories} annotation.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
class JdbcRepositoriesRegistrar extends RepositoryBeanDefinitionRegistrarSupport {

View File

@@ -25,7 +25,7 @@ import org.springframework.data.repository.config.RepositoryConfigurationExtensi
* registration process by registering JDBC repositories.
*
* @author Jens Schauder
* @since 2.0
* @since 1.0
*/
public class JdbcRepositoryConfigExtension extends RepositoryConfigurationExtensionSupport {

View File

@@ -25,6 +25,7 @@ import java.lang.annotation.Target;
* Indicates a method should be regarded as modifying query.
*
* @author Kazuki Shimizu
* @since 1.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })

View File

@@ -31,6 +31,7 @@ import org.springframework.jdbc.core.RowMapper;
* Those parameters will get bound to the arguments of the annotated method.
*
* @author Jens Schauder
* @since 1.0
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)

View File

@@ -36,6 +36,7 @@ import org.springframework.jdbc.core.SingleColumnRowMapper;
*
* @author Jens Schauder
* @author Kazuki Shimizu
* @since 1.0
*/
class JdbcQueryLookupStrategy implements QueryLookupStrategy {

View File

@@ -32,6 +32,7 @@ import org.springframework.lang.Nullable;
*
* @author Jens Schauder
* @author Kazuki Shimizu
* @since 1.0
*/
public class JdbcQueryMethod extends QueryMethod {

View File

@@ -29,6 +29,7 @@ import org.springframework.util.StringUtils;
*
* @author Jens Schauder
* @author Kazuki Shimizu
* @since 1.0
*/
class JdbcRepositoryQuery implements RepositoryQuery {

View File

@@ -32,6 +32,7 @@ import org.springframework.jdbc.support.JdbcUtils;
* Contains methods dealing with the quirks of JDBC, independent of any Entity, Aggregate or Repository abstraction.
*
* @author Jens Schauder
* @since 1.0
*/
@UtilityClass
public class JdbcUtil {