GORA-490 added package-info files for gora-mongodb
Project: http://git-wip-us.apache.org/repos/asf/gora/repo Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/75243c6a Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/75243c6a Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/75243c6a Branch: refs/heads/master Commit: 75243c6a4713d3fb7958538cd2f3994620c094f8 Parents: a6cb1da Author: cihad guzel <[email protected]> Authored: Thu Aug 25 00:45:48 2016 +0300 Committer: cihad guzel <[email protected]> Committed: Thu Aug 25 01:37:57 2016 +0300 ---------------------------------------------------------------------- .../gora/mongodb/filters/package-info.java | 20 +++++++++++++++++++ .../apache/gora/mongodb/query/package-info.java | 21 ++++++++++++++++++++ .../apache/gora/mongodb/store/MongoStore.java | 6 ++---- .../mongodb/store/MongoStoreParameters.java | 4 ++-- .../apache/gora/mongodb/store/package-info.java | 20 +++++++++++++++++++ .../gora/mongodb/utils/GoraDBEncoder.java | 3 +++ .../apache/gora/mongodb/utils/package-info.java | 20 +++++++++++++++++++ .../org/apache/gora/mongodb/package-info.java | 21 ++++++++++++++++++++ 8 files changed, 109 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/filters/package-info.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/filters/package-info.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/filters/package-info.java new file mode 100644 index 0000000..83ba0e9 --- /dev/null +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/filters/package-info.java @@ -0,0 +1,20 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 MongoDB store related util classes. + */ +package org.apache.gora.mongodb.filters; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/query/package-info.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/query/package-info.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/query/package-info.java new file mode 100644 index 0000000..997886e --- /dev/null +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/query/package-info.java @@ -0,0 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 all the MongoDB store query representation class as well as Result set representing class + * when query is executed over the MongoDB dataStore. + */ +package org.apache.gora.mongodb.query; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStore.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStore.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStore.java index c0a1d25..d4771df 100644 --- a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStore.java +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStore.java @@ -134,10 +134,8 @@ DataStoreBase<K, T> { /** * Retrieve a client connected to the MongoDB server to be used. * - * @param servers - * This value should specify the host:port (at least one) for - * connecting to remote MongoDB. Multiple values must be separated by - * coma. + * @param params This value should specify the host:port (at least one) for + * connecting to remote MongoDB. * @return a {@link Mongo} instance connected to the server * @throws UnknownHostException */ http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java index 890e6d3..020dcf9 100644 --- a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/MongoStoreParameters.java @@ -23,12 +23,12 @@ import org.apache.hadoop.conf.Configuration; import java.util.Properties; /** + * Configuration properties + * * @author Damien Raude-Morvan */ public class MongoStoreParameters { - // Configuration properties - /** * Property indicating if the hadoop configuration has priority or not */ http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/package-info.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/package-info.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/package-info.java new file mode 100644 index 0000000..d8ef933 --- /dev/null +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/store/package-info.java @@ -0,0 +1,20 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 all the MongoDB store related classes. + */ +package org.apache.gora.mongodb.store; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/GoraDBEncoder.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/GoraDBEncoder.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/GoraDBEncoder.java index acd725b..587968a 100644 --- a/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/GoraDBEncoder.java +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/GoraDBEncoder.java @@ -25,6 +25,9 @@ import com.mongodb.DBEncoder; import com.mongodb.DBEncoderFactory; import com.mongodb.DefaultDBEncoder; +/** + * BSON encoder for BSONObject instances. + */ public class GoraDBEncoder extends DefaultDBEncoder { public static DBEncoderFactory FACTORY = new DefaultFactory(); http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/package-info.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/package-info.java b/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/package-info.java new file mode 100644 index 0000000..261361b --- /dev/null +++ b/gora-mongodb/src/main/java/org/apache/gora/mongodb/utils/package-info.java @@ -0,0 +1,20 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 MongoDB store related util classes. + */ +package org.apache.gora.mongodb.utils; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/gora/blob/75243c6a/gora-mongodb/src/test/java/org/apache/gora/mongodb/package-info.java ---------------------------------------------------------------------- diff --git a/gora-mongodb/src/test/java/org/apache/gora/mongodb/package-info.java b/gora-mongodb/src/test/java/org/apache/gora/mongodb/package-info.java new file mode 100644 index 0000000..2b5c120 --- /dev/null +++ b/gora-mongodb/src/test/java/org/apache/gora/mongodb/package-info.java @@ -0,0 +1,21 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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. + */ +/** + * Tests for <code>gora-mongodb</code> including + * the test driver for {@link org.apache.gora.mongodb.GoraMongodbTestDriver} + */ +package org.apache.gora.mongodb; \ No newline at end of file
