From 67373e501e026690e2206f9a5e2b23c08a62c8b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Basl=C3=A9?= Date: Tue, 23 Feb 2016 16:00:04 +0100 Subject: [PATCH] DATACOUCH-204 - Add package-info on all packages --- .../data/couchbase/config/package-info.java | 2 +- .../couchbase/core/convert/package-info.java | 5 +++++ .../core/convert/translation/package-info.java | 5 +++++ .../core/mapping/event/package-info.java | 5 +++++ .../couchbase/core/mapping/package-info.java | 5 +++++ .../data/couchbase/core/package-info.java | 18 +----------------- .../couchbase/core/query/package-info.java | 5 +++++ .../data/couchbase/monitor/package-info.java | 2 +- .../couchbase/repository/cdi/package-info.java | 4 ++++ .../repository/config/package-info.java | 4 ++++ .../couchbase/repository/package-info.java | 2 +- .../repository/query/package-info.java | 5 +++++ .../repository/query/support/package-info.java | 5 +++++ .../repository/support/package-info.java | 7 +++++++ 14 files changed, 54 insertions(+), 20 deletions(-) create mode 100644 src/main/java/org/springframework/data/couchbase/core/convert/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/core/convert/translation/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/core/mapping/event/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/core/mapping/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/core/query/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/repository/cdi/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/repository/config/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/repository/query/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/repository/query/support/package-info.java create mode 100644 src/main/java/org/springframework/data/couchbase/repository/support/package-info.java diff --git a/src/main/java/org/springframework/data/couchbase/config/package-info.java b/src/main/java/org/springframework/data/couchbase/config/package-info.java index 4bfb6547..9de02508 100644 --- a/src/main/java/org/springframework/data/couchbase/config/package-info.java +++ b/src/main/java/org/springframework/data/couchbase/config/package-info.java @@ -2,4 +2,4 @@ * This package contains all classes needed for specific configuration of * Spring Data Couchbase. */ -package org.springframework.data.couchbase.config; \ No newline at end of file +package org.springframework.data.couchbase.config; diff --git a/src/main/java/org/springframework/data/couchbase/core/convert/package-info.java b/src/main/java/org/springframework/data/couchbase/core/convert/package-info.java new file mode 100644 index 00000000..fdc2aeea --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/core/convert/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains classes used for entity-to-JSON conversions, type mapping + * and writing. + */ +package org.springframework.data.couchbase.core.convert; diff --git a/src/main/java/org/springframework/data/couchbase/core/convert/translation/package-info.java b/src/main/java/org/springframework/data/couchbase/core/convert/translation/package-info.java new file mode 100644 index 00000000..9c9f7d02 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/core/convert/translation/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains a service interface to translate entities to + * a Couchbase storable format, and its implementations. + */ +package org.springframework.data.couchbase.core.convert.translation; diff --git a/src/main/java/org/springframework/data/couchbase/core/mapping/event/package-info.java b/src/main/java/org/springframework/data/couchbase/core/mapping/event/package-info.java new file mode 100644 index 00000000..9cde06e5 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/core/mapping/event/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains various events that are emitted during the lifecycle + * of a Spring Data entity. + */ +package org.springframework.data.couchbase.core.mapping.event; diff --git a/src/main/java/org/springframework/data/couchbase/core/mapping/package-info.java b/src/main/java/org/springframework/data/couchbase/core/mapping/package-info.java new file mode 100644 index 00000000..8ca5d063 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/core/mapping/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains interfaces and annotations relative to object-json mapping + * and the notion of a Couchbase Storable. + */ +package org.springframework.data.couchbase.core.mapping; \ No newline at end of file diff --git a/src/main/java/org/springframework/data/couchbase/core/package-info.java b/src/main/java/org/springframework/data/couchbase/core/package-info.java index ddb60dfc..02afcbd4 100644 --- a/src/main/java/org/springframework/data/couchbase/core/package-info.java +++ b/src/main/java/org/springframework/data/couchbase/core/package-info.java @@ -1,19 +1,3 @@ -/* - * Copyright 2012-2015 the original author or authors - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - /** * This package contains the specific implementations and core classes for * Spring Data Couchbase internals. It also contains Couchbase implementation @@ -23,4 +7,4 @@ * repositories. Any time a repository is too high-level for you needs chances are good that the templates will serve * you well. */ -package org.springframework.data.couchbase.core; \ No newline at end of file +package org.springframework.data.couchbase.core; diff --git a/src/main/java/org/springframework/data/couchbase/core/query/package-info.java b/src/main/java/org/springframework/data/couchbase/core/query/package-info.java new file mode 100644 index 00000000..263ad066 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/core/query/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains annotations and classes relative to querying with Couchbase + * (whether through views or N1QL) and the associated indexes. + */ +package org.springframework.data.couchbase.core.query; \ No newline at end of file diff --git a/src/main/java/org/springframework/data/couchbase/monitor/package-info.java b/src/main/java/org/springframework/data/couchbase/monitor/package-info.java index d64a4c07..be1786d4 100644 --- a/src/main/java/org/springframework/data/couchbase/monitor/package-info.java +++ b/src/main/java/org/springframework/data/couchbase/monitor/package-info.java @@ -2,4 +2,4 @@ * This package contains all classes related to monitoring the Couchbase cluster, * statistics that will be exposed as JMX beans. */ -package org.springframework.data.couchbase.monitor; \ No newline at end of file +package org.springframework.data.couchbase.monitor; diff --git a/src/main/java/org/springframework/data/couchbase/repository/cdi/package-info.java b/src/main/java/org/springframework/data/couchbase/repository/cdi/package-info.java new file mode 100644 index 00000000..f3cb87b1 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/repository/cdi/package-info.java @@ -0,0 +1,4 @@ +/** + * This package contains the Couchbase implementation to integrate the Spring Data repository abstraction with CDI. + */ +package org.springframework.data.couchbase.repository.cdi; diff --git a/src/main/java/org/springframework/data/couchbase/repository/config/package-info.java b/src/main/java/org/springframework/data/couchbase/repository/config/package-info.java new file mode 100644 index 00000000..cf30e812 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/repository/config/package-info.java @@ -0,0 +1,4 @@ +/** + * This package contains the support classes to configure repositories in the context of Couchbase. + */ +package org.springframework.data.couchbase.repository.config; diff --git a/src/main/java/org/springframework/data/couchbase/repository/package-info.java b/src/main/java/org/springframework/data/couchbase/repository/package-info.java index b01e083a..51952c15 100644 --- a/src/main/java/org/springframework/data/couchbase/repository/package-info.java +++ b/src/main/java/org/springframework/data/couchbase/repository/package-info.java @@ -1,5 +1,5 @@ /** - * This package contains the Couchbase implementation to support the Spring Data repository abstraction. + * This package contains the Couchbase interfaces to support the Spring Data repository abstraction. *
* The goal of Spring Data repository abstraction is to significantly reduce the amount of boilerplate code required to * implement data access layers for various persistence stores. diff --git a/src/main/java/org/springframework/data/couchbase/repository/query/package-info.java b/src/main/java/org/springframework/data/couchbase/repository/query/package-info.java new file mode 100644 index 00000000..ad1c3220 --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/repository/query/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains classes related to query derivation and concrete + * ways of querying couchbase. + */ +package org.springframework.data.couchbase.repository.query; diff --git a/src/main/java/org/springframework/data/couchbase/repository/query/support/package-info.java b/src/main/java/org/springframework/data/couchbase/repository/query/support/package-info.java new file mode 100644 index 00000000..f6888bbd --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/repository/query/support/package-info.java @@ -0,0 +1,5 @@ +/** + * This package contains support classes for query derivation and other + * ways of querying couchbase (helper classes). + */ +package org.springframework.data.couchbase.repository.query.support; diff --git a/src/main/java/org/springframework/data/couchbase/repository/support/package-info.java b/src/main/java/org/springframework/data/couchbase/repository/support/package-info.java new file mode 100644 index 00000000..d856fa1e --- /dev/null +++ b/src/main/java/org/springframework/data/couchbase/repository/support/package-info.java @@ -0,0 +1,7 @@ +/** + * This package contains the Couchbase implementations to support the Spring Data repository abstraction. + *
+ * This includes repository factories and factory beans, concrete base repository classes, metadata providers + * and a class in charge of managing various indexes (views, N1QL). + */ +package org.springframework.data.couchbase.repository.support;