diff --git a/.gitignore b/.gitignore index a0725e0..9cf7c65 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ ### Gradle ### .gradle build/ +gradle.properties # Ignore Gradle GUI config gradle-app.setting diff --git a/README.md b/README.md index 6456ae6..19c16f7 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,9 @@ public class Employee { return name; } ... + //this column will not be presented in the excel sheet. + @NoSheetColumn() + private String socialSecurityNumber; } ``` diff --git a/build.gradle b/build.gradle index 835a33b..2b2d0f5 100644 --- a/build.gradle +++ b/build.gradle @@ -1,45 +1,95 @@ +// apply plugin: 'java' +// apply plugin: 'jacoco' -apply plugin: 'java' -apply plugin: 'jacoco' - +// apply plugin: 'signing' +apply plugin: 'java-library' apply plugin: 'maven' apply plugin: 'signing' + repositories { - mavenLocal() + jcenter() mavenCentral() + google() } -group = 'io.github.millij' -version = '2.0.0-SNAPSHOT' - dependencies { + // https://mvnrepository.com/artifact/org.slf4j/slf4j-api + implementation 'org.slf4j:slf4j-api:1.7.26' + + // https://mvnrepository.com/artifact/commons-beanutils/commons-beanutils + implementation 'commons-beanutils:commons-beanutils:1.9.3' + + // https://mvnrepository.com/artifact/org.apache.poi/poi + implementation 'org.apache.poi:poi:4.0.1' - // Main compile - // ---------------------------------------------------------------------------------- + // https://mvnrepository.com/artifact/org.apache.poi/poi-ooxml + implementation 'org.apache.poi:poi-ooxml:4.0.1' - // Slf4j - compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.12' + // https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 + implementation 'org.apache.commons:commons-lang3:3.9' - // Apache Commons - compile group: 'org.apache.commons', name: 'commons-lang3', version: '3.5' - compile group: 'commons-beanutils', name: 'commons-beanutils', version: '1.9.3' + // https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 + testImplementation 'org.slf4j:slf4j-log4j12:1.7.26' + // https://mvnrepository.com/artifact/junit/junit + testImplementation 'junit:junit:4.13' - // Apache POI - compile group: 'org.apache.poi', name: 'poi', version: '4.0.1' - compile group: 'org.apache.poi', name: 'poi-ooxml', version: '4.0.1' - // Test compile - // ---------------------------------------------------------------------------------- +} + +uploadArchives { + repositories { + mavenDeployer { + beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) } + + repository(url: "https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/") { + authentication(userName: 'relbraun', password: '081982@Ariel') + } + + snapshotRepository(url: "https://s01.oss.sonatype.org/content/repositories/snapshots/") { + authentication(userName: 'relbraun', password: '081982@Ariel') + } - testCompile group: 'org.slf4j', name: 'slf4j-log4j12', version: '1.7.12' + pom.project { - testCompile group: 'junit', name: 'junit', version: '4.12' + name 'Object Mapper for Apache POI' + description 'Objects mapper for Office formats - Excel files, Spreadsheets, etc. ' + url 'https://github.com/relbraun/poi-object-mapper' + packaging 'jar' + // optionally artifactId can be defined here + scm { + url 'https://github.com/relbraun/poi-object-mapper.git' + connection 'scm:git:https://github.com/relbraun/poi-object-mapper.git' + developerConnection 'scm:git:https://github.com/relbraun/poi-object-mapper.git' + } + + licenses { + license { + name 'MIT License' + url 'https://opensource.org/licenses/mit-license.php' + } + } + + developers { + developer { + id 'relbraun' + name 'Ariel Braun' + email 'relbraun@gmail.com' + } + } + } + } + } } + +group = 'io.github.relbraun' +version = '2.0.2' + + // Test // ---------------------------------------------------------------------------- @@ -51,110 +101,59 @@ test { // Java // ---------------------------------------------------------------------------- -tasks.withType(JavaCompile) { - sourceCompatibility = 1.7 - targetCompatibility = 1.7 -} +// tasks.withType(JavaCompile) { +// sourceCompatibility = 1.7 +// targetCompatibility = 1.7 +// } -task javadocJar(type: Jar) { - classifier = 'javadoc' - from javadoc -} +// task javadocJar(type: Jar) { +// classifier = 'javadoc' +// from javadoc +// } -task sourcesJar(type: Jar) { - classifier = 'sources' - from sourceSets.main.allSource -} +// task sourcesJar(type: Jar) { +// classifier = 'sources' +// from sourceSets.main.allSource +// } artifacts { archives jar - archives javadocJar - archives sourcesJar + // archives javadocJar + // archives sourcesJar } // Signing -signing { - sign configurations.archives -} - +// signing { +// sign configurations.archives +// } // JaCoCo // ---------------------------------------------------------------------------- -jacocoTestReport { - reports { - xml.enabled = true - html.enabled = true - } -} +// jacocoTestReport { +// reports { +// xml.enabled = true +// html.enabled = true +// } +// } -jacocoTestReport.dependsOn test +// jacocoTestReport.dependsOn test -check.dependsOn jacocoTestReport +// check.dependsOn jacocoTestReport // CheckStyle // ---------------------------------------------------------------------------- - // Release // ---------------------------------------------------------------------------- -uploadArchives { - - repositories { - mavenDeployer { - - // Sign Artifacts before deploying - beforeDeployment { - MavenDeployment deployment -> signing.signPom(deployment) - } - - // Staging Repo - repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") { - authentication(userName: ossrhUsername, password: ossrhPassword) - } - - // Snapshot Repo - snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") { - authentication(userName: ossrhUsername, password: ossrhPassword) - } - - - // Project Info to generate POM - pom.project { - name 'Object Mapper for Apache POI' - packaging 'jar' - description 'Objects mapper for Office formats - Excel files, Spreadsheets, etc. ' - url 'https://millij.github.io/poi-object-mapper/' - - scm { - url 'https://github.com/millij/poi-object-mapper.git' - connection 'scm:git:https://github.com/millij/poi-object-mapper.git' - developerConnection 'scm:git:https://github.com/millij/poi-object-mapper.git' - } - licenses { - license { - name 'MIT License' - url 'https://opensource.org/licenses/mit-license.php' - } - } +// apply plugin: 'com.bmuschko.nexus' - developers { - developer { - id 'millij' - name 'Gowri Shankar' - email 'gowrishankar.milli@gmail.com' - } - } - } // POM - - } // mavenDeployer +archivesBaseName = 'poi-object-mapper' - } -} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index d583fe7..e708b1c 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index c4a9e52..28ff446 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,5 @@ -#Sun Dec 10 18:59:49 IST 2017 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-bin.zip diff --git a/gradlew b/gradlew index 4453cce..4f906e0 100755 --- a/gradlew +++ b/gradlew @@ -1,5 +1,21 @@ #!/usr/bin/env sh +# +# Copyright 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 +# +# https://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. +# + ############################################################################## ## ## Gradle start up script for UN*X @@ -28,16 +44,16 @@ APP_NAME="Gradle" APP_BASE_NAME=`basename "$0"` # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" -warn ( ) { +warn () { echo "$*" } -die ( ) { +die () { echo echo "$*" echo @@ -66,6 +82,7 @@ esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then @@ -109,10 +126,11 @@ if $darwin; then GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" fi -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then APP_HOME=`cygpath --path --mixed "$APP_HOME"` CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` # We build the pattern for arguments to be converted via cygpath @@ -138,35 +156,30 @@ if $cygwin ; then else eval `echo args$i`="\"$arg\"" fi - i=$((i+1)) + i=`expr $i + 1` done case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; esac fi # Escape application args -save ( ) { +save () { for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done echo " " } -APP_ARGS=$(save "$@") +APP_ARGS=`save "$@"` # Collect all arguments for the java command, following the shell quoting and substitution rules eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi - exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index f955316..107acd3 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,3 +1,19 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @@ -13,15 +29,18 @@ if "%DIRNAME%" == "" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if "%ERRORLEVEL%" == "0" goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -35,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -45,28 +64,14 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* :end @rem End local scope for the variables with windows NT shell diff --git a/src/main/java/io/github/millij/poi/ss/model/annotations/NoSheetColumn.java b/src/main/java/io/github/millij/poi/ss/model/annotations/NoSheetColumn.java new file mode 100644 index 0000000..b30e02c --- /dev/null +++ b/src/main/java/io/github/millij/poi/ss/model/annotations/NoSheetColumn.java @@ -0,0 +1,28 @@ +package io.github.millij.poi.ss.model.annotations; + +import static java.lang.annotation.ElementType.TYPE; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + + +/** + * Marker annotation that can be used to define a "type" for a sheet. The value of this annotation + * will be used to map the sheet of the workbook to this bean definition. + * + *
+ * Default value ("") indicates that the default sheet name to be used without any modifications, + * but it can be specified to non-empty value to specify different name. + *
+ * + *+ * Typically used when writing the java objects to the file. + *
+ */ +@Retention(RUNTIME) +@Target(TYPE) +public @interface NoSheetColumn { + + +} diff --git a/src/main/java/io/github/millij/poi/util/Spreadsheet.java b/src/main/java/io/github/millij/poi/util/Spreadsheet.java index 5412bf5..9e54197 100644 --- a/src/main/java/io/github/millij/poi/util/Spreadsheet.java +++ b/src/main/java/io/github/millij/poi/util/Spreadsheet.java @@ -1,6 +1,7 @@ package io.github.millij.poi.util; import io.github.millij.poi.ss.model.annotations.SheetColumn; +import io.github.millij.poi.ss.model.annotations.NoSheetColumn; import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; @@ -58,6 +59,8 @@ public static Map