From 34750cf9a8ca06f7bd3213ade443b892e2abec85 Mon Sep 17 00:00:00 2001 From: "Michael J. Simons" Date: Tue, 24 Jul 2018 18:04:36 +0200 Subject: [PATCH] DATAGRAPH-371 - Document packages with package-infos. Merges #417 --- .../data/neo4j/annotation/package-info.java | 4 ++++ .../data/neo4j/bookmark/package-info.java | 4 ++++ .../data/neo4j/conversion/package-info.java | 5 +++++ .../data/neo4j/exception/package-info.java | 4 ++++ .../data/neo4j/mapping/package-info.java | 4 ++++ .../neo4j/repository/config/package-info.java | 16 +--------------- .../data/neo4j/repository/package-info.java | 4 ++++ .../query/derived/builder/package-info.java | 4 ++++ .../repository/query/derived/package-info.java | 4 ++++ .../neo4j/repository/query/package-info.java | 4 ++++ .../repository/query/spel/package-info.java | 4 ++++ .../neo4j/repository/support/package-info.java | 4 ++++ .../data/neo4j/transaction/package-info.java | 4 ++++ .../data/neo4j/util/package-info.java | 4 ++++ .../data/neo4j/web/support/package-info.java | 4 ++++ 15 files changed, 58 insertions(+), 15 deletions(-) create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/annotation/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/bookmark/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/conversion/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/exception/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/mapping/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/builder/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/spel/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/support/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/transaction/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/util/package-info.java create mode 100644 spring-data-neo4j/src/main/java/org/springframework/data/neo4j/web/support/package-info.java diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/annotation/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/annotation/package-info.java new file mode 100644 index 000000000..a68d8b04c --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/annotation/package-info.java @@ -0,0 +1,4 @@ +/** + * A set of Neo4j specific annotations (especially Depth and Bookmark support). + */ +package org.springframework.data.neo4j.annotation; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/bookmark/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/bookmark/package-info.java new file mode 100644 index 000000000..46401419c --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/bookmark/package-info.java @@ -0,0 +1,4 @@ +/** + * Support for Neo4js bookmarks for use with the java driver / bolt transport. + */ +package org.springframework.data.neo4j.bookmark; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/conversion/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/conversion/package-info.java new file mode 100644 index 000000000..a91cab0b3 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/conversion/package-info.java @@ -0,0 +1,5 @@ +/** + * Adapter between Springs {@link org.springframework.core.convert.ConversionService conversion service infrastructure} + * and OGM infrastructure. + */ +package org.springframework.data.neo4j.conversion; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/exception/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/exception/package-info.java new file mode 100644 index 000000000..734879cf2 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/exception/package-info.java @@ -0,0 +1,4 @@ +/** + * Contains infrastructure for mapping Neo4j errors to Spring Data Exception hierarchy. + */ +package org.springframework.data.neo4j.exception; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/mapping/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/mapping/package-info.java new file mode 100644 index 000000000..3cd493fba --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/mapping/package-info.java @@ -0,0 +1,4 @@ +/** + * Neo4j specific support classes for the Spring Data mapping subsystem. + */ +package org.springframework.data.neo4j.mapping; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/config/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/config/package-info.java index 870f72441..3575fecc5 100644 --- a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/config/package-info.java +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/config/package-info.java @@ -1,18 +1,4 @@ -/* - * Copyright (c) [2011-2017] "Pivotal Software, Inc." / "Neo Technology" / "Graph Aware Ltd." - * - * This product is licensed to you under the Apache License, Version 2.0 (the "License"). - * You may not use this product except in compliance with the License. - * - * This product may include a number of subcomponents with - * separate copyright notices and license terms. Your use of the source - * code for these subcomponents is subject to the terms and - * conditions of the subcomponent's license, as noted in the LICENSE file. - * - */ - /** - * Support classes for repository namespace and JavaConfig integration. + * Classes for Neo4j namespace configuration. */ -@org.springframework.lang.NonNullApi package org.springframework.data.neo4j.repository.config; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/package-info.java new file mode 100644 index 000000000..d5934091b --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/package-info.java @@ -0,0 +1,4 @@ +/** + * Infrastructure for Neo4j specific repositories. + */ +package org.springframework.data.neo4j.repository; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/builder/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/builder/package-info.java new file mode 100644 index 000000000..4b70fb5c3 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/builder/package-info.java @@ -0,0 +1,4 @@ +/** + * Builder classes to create Neo4j-OGM filters. + */ +package org.springframework.data.neo4j.repository.query.derived.builder; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/package-info.java new file mode 100644 index 000000000..f3dff45c6 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/derived/package-info.java @@ -0,0 +1,4 @@ +/** + * Derived query creation. + */ +package org.springframework.data.neo4j.repository.query.derived; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/package-info.java new file mode 100644 index 000000000..ed6876d87 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/package-info.java @@ -0,0 +1,4 @@ +/** + * Query implementation to execute queries against Neo4j. + */ +package org.springframework.data.neo4j.repository.query; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/spel/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/spel/package-info.java new file mode 100644 index 000000000..497852466 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/query/spel/package-info.java @@ -0,0 +1,4 @@ +/** + * Spring Expression Language (SpEL) support. + */ +package org.springframework.data.neo4j.repository.query.spel; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/support/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/support/package-info.java new file mode 100644 index 000000000..30e8365eb --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/repository/support/package-info.java @@ -0,0 +1,4 @@ +/** + * Neo4j repository implementations. + */ +package org.springframework.data.neo4j.repository.support; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/transaction/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/transaction/package-info.java new file mode 100644 index 000000000..e228a2024 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/transaction/package-info.java @@ -0,0 +1,4 @@ +/** + * Spring Data Neo4js implementation of a {@link org.springframework.transaction.PlatformTransactionManager}. + */ +package org.springframework.data.neo4j.transaction; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/util/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/util/package-info.java new file mode 100644 index 000000000..3715ab31b --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/util/package-info.java @@ -0,0 +1,4 @@ +/** + * Util classes for iteration and pagination. + */ +package org.springframework.data.neo4j.util; diff --git a/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/web/support/package-info.java b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/web/support/package-info.java new file mode 100644 index 000000000..74fc0fe35 --- /dev/null +++ b/spring-data-neo4j/src/main/java/org/springframework/data/neo4j/web/support/package-info.java @@ -0,0 +1,4 @@ +/** + * Support classes for web requests. + */ +package org.springframework.data.neo4j.web.support;