Added package infos (#592)

building-tools/src/main/resources/loose-checkstyle.xml

@@ -35,7 +35,7 @@
     </module>
 
     <module name="FileLength"/>
-    <!-- todo <module name="JavadocPackage"/> -->
+    <module name="JavadocPackage"/>
 
     <module name="TreeWalker">
 

core/src/main/java/com/github/dozermapper/core/builder/fluent/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Build mappings via Java Fluent API
+ */
+package com.github.dozermapper.core.builder.fluent;

core/src/main/java/com/github/dozermapper/core/builder/model/elengine/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * {@link com.github.dozermapper.core.el.ELEngine} extension to JAXB model
+ */
+package com.github.dozermapper.core.builder.model.elengine;

core/src/main/java/com/github/dozermapper/core/builder/model/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Models that describes the mapping definitions
+ */
+package com.github.dozermapper.core.builder.model;

core/src/main/java/com/github/dozermapper/core/builder/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Build mappings via different API extensions
+ */
+package com.github.dozermapper.core.builder;

core/src/main/java/com/github/dozermapper/core/builder/xml/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Build mappings via XML
+ */
+package com.github.dozermapper.core.builder.xml;

core/src/main/java/com/github/dozermapper/core/cache/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Caching for dozer objects
+ */
+package com.github.dozermapper.core.cache;

core/src/main/java/com/github/dozermapper/core/classmap/generator/MappingType.java

@@ -19,6 +19,7 @@
  * Defines the mapping style to use between the source and target objects.
  */
 public enum MappingType {
+
     /**
      * Map from source field to target field
      */

core/src/main/java/com/github/dozermapper/core/classmap/generator/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Generators to resolve the different types and their fields
+ */
+package com.github.dozermapper.core.classmap.generator;

core/src/main/java/com/github/dozermapper/core/classmap/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Mapping definition used internally for classes
+ */
+package com.github.dozermapper.core.classmap;

core/src/main/java/com/github/dozermapper/core/config/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Configuration settings for
+ */
+package com.github.dozermapper.core.config;

core/src/main/java/com/github/dozermapper/core/config/processors/DefaultSettingsProcessor.java

@@ -28,6 +28,10 @@
 import com.github.dozermapper.core.util.DozerClassLoader;
 import com.github.dozermapper.core.util.MappingUtils;
 
+/**
+ * Processes default resolvers, which are currently:
+ * {@link LegacyPropertiesSettingsResolver}, {@link SystemPropertySettingsResolver} and {@link SystemEnvironmentSettingsResolver}
+ */
 public class DefaultSettingsProcessor implements SettingsProcessor {
 
     private final DozerClassLoader classLoader;
@@ -37,6 +41,9 @@ public DefaultSettingsProcessor(DozerClassLoader classLoader) {
         this.classLoader = classLoader;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Settings process() {
         createSettingsResolvers();

core/src/main/java/com/github/dozermapper/core/config/processors/SettingsProcessor.java

@@ -17,7 +17,15 @@
 
 import com.github.dozermapper.core.config.Settings;
 
+/**
+ * Processes values retrieved by resolvers, to create {@link Settings}
+ */
 public interface SettingsProcessor {
 
+    /**
+     * Process resolvers to create {@link Settings}
+     *
+     * @return Configured {@link Settings}
+     */
     Settings process();
 }

core/src/main/java/com/github/dozermapper/core/config/processors/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Processes values retrieved by resolvers
+ */
+package com.github.dozermapper.core.config.processors;

core/src/main/java/com/github/dozermapper/core/config/resolvers/LegacyPropertiesSettingsResolver.java

@@ -42,6 +42,9 @@ public LegacyPropertiesSettingsResolver(DozerClassLoader classLoader, String con
         this.configFile = configFile;
     }
 
+    /**
+     * Loads dozer.properties from classpath
+     */
     @Override
     public void init() {
         properties = processFile();
@@ -73,6 +76,9 @@ private Properties processFile() {
         return properties;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Object get(String key, Object defaultValue) {
         return properties.getOrDefault(key, defaultValue);

core/src/main/java/com/github/dozermapper/core/config/resolvers/SettingsResolver.java

@@ -20,7 +20,16 @@
  */
 public interface SettingsResolver {
 
+    /**
+     * Initializes backing store and retrieves values into memory
+     */
     void init();
 
+    /**
+     * Gets value from in memory store
+     * @param key key to retrieve
+     * @param defaultValue value to default to if none found
+     * @return value found or default if none
+     */
     Object get(String key, Object defaultValue);
 }

core/src/main/java/com/github/dozermapper/core/config/resolvers/SystemEnvironmentSettingsResolver.java

@@ -24,11 +24,20 @@
  */
 public class SystemEnvironmentSettingsResolver implements SettingsResolver {
 
+    /**
+     * No-op
+     */
     @Override
     public void init() {
         //noop
     }
 
+    /**
+     * Gets value from environment via {@link System#getenv}
+     * @param key key to retrieve
+     * @param defaultValue value to default to if none found
+     * @return value found or default if none
+     */
     @Override
     public Object get(String key, Object defaultValue) {
         Object value = System.getenv(getEnvironmentSafeKey(key));

core/src/main/java/com/github/dozermapper/core/config/resolvers/SystemPropertySettingsResolver.java

@@ -20,11 +20,20 @@
  */
 public class SystemPropertySettingsResolver implements SettingsResolver {
 
+    /**
+     * No-op
+     */
     @Override
     public void init() {
         //noop
     }
 
+    /**
+     * Gets value from system via {@link System#getProperty}
+     * @param key key to retrieve
+     * @param defaultValue value to default to if none found
+     * @return value found or default if none
+     */
     @Override
     public Object get(String key, Object defaultValue) {
         return System.getProperty(key, defaultValue == null ? null : String.valueOf(defaultValue));

core/src/main/java/com/github/dozermapper/core/config/resolvers/YAMLSettingsResolver.java

@@ -56,6 +56,9 @@ public YAMLSettingsResolver(DozerClassLoader classLoader, String configFile) {
         this.configFile = configFile;
     }
 
+    /**
+     * Loads dozer.yaml from classpath
+     */
     @Override
     public void init() {
         Map<String, Map> settings = processFile();
@@ -117,6 +120,9 @@ private void processSettingsMap(Map<String, Map> settings) {
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Object get(String key, Object defaultValue) {
         return properties.getOrDefault(key, defaultValue);

core/src/main/java/com/github/dozermapper/core/config/resolvers/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Resolves values defined in a resource, such as .properties file
+ */
+package com.github.dozermapper.core.config.resolvers;

core/src/main/java/com/github/dozermapper/core/converters/package-info.java

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2005-2018 Dozer Project
+ *
+ * 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.
+ */
+/**
+ * Convertor extensions based on {@link org.apache.commons.beanutils.Converter}
+ */
+package com.github.dozermapper.core.converters;