Skip to content

Files

Latest commit

de84293 · Jan 29, 2019

History

History
This branch is 1 commit ahead of, 13757 commits behind apache/arrow:main.

java

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jan 23, 2019
Jan 23, 2019
Jan 29, 2019
Jan 19, 2019
Jan 28, 2019
Jan 23, 2019
Jan 24, 2019
Jan 24, 2019
Jan 23, 2019
Dec 12, 2017
Oct 12, 2017
Jan 26, 2019
Jan 23, 2019
Jan 24, 2019

Arrow Java

Setup Build Environment

install:

  • java 7 or later
  • maven 3.3 or later

Building and running tests

cd java
mvn install

Building and running tests for gandiva (optional)

Gandiva cpp must be built before this step. The cpp build directory must be provided as the value for argument gandiva.cpp.build.dir. eg.

cd java
mvn install -P gandiva -pl gandiva -am -Dgandiva.cpp.build.dir=../../debug

This library is still in Alpha stages, and subject to API changes without deprecation warnings.

Java Code Style Guide

Arrow Java follows the Google style guide here with the following differences:

  • Imports are grouped, from top to bottom, in this order: static imports, standard Java, org.*, com.*
  • Line length can be up to 120 characters
  • Operators for line wrapping are at end-of-line
  • Naming rules for methods, parameters, etc. have been relaxed
  • Disabled NoFinalizer, OverloadMethodsDeclarationOrder, and VariableDeclarationUsageDistance due to the existing code base. These rules should be followed when possible.

Refer to `java/dev/checkstyle/checkstyle.xml for rule specifics.

Test Logging Configuration

When running tests, Arrow Java uses the Logback logger with SLF4J. By default, it uses the logback.xml present in the corresponding module's src/test/resources directory, which has the default log level set to INFO. Arrow Java can be built with an alternate logback configuration file using the following command run in the project root directory:

mvn -Dlogback.configurationFile=file:<path-of-logback-file>

See Logback Configuration for more details.