Skip to content

Commit 6aba222

Browse files
committed
Add initial build system and other project template files
1 parent 385933f commit 6aba222

File tree

14 files changed

+1618
-0
lines changed

14 files changed

+1618
-0
lines changed

.classpath

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<classpath>
3+
<classpathentry kind="src" output="build/classes/test" path="src/test/java"/>
4+
<classpathentry kind="src" output="build/classes/main" path="src/main/java"/>
5+
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER">
6+
<attributes>
7+
<attribute name="module" value="true"/>
8+
</attributes>
9+
</classpathentry>
10+
<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4"/>
11+
<classpathentry kind="lib" path="build/dependencies/threadly-5.42.jar"/>
12+
<classpathentry kind="output" path="build/classes/bin"/>
13+
</classpath>

.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
*.class
2+
3+
# Package Files #
4+
*.jar
5+
*.war
6+
*.ear
7+
8+
.gradle
9+
build
10+
/.nb-gradle/

.project

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>threadly-test</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.jdt.core.javabuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>net.sf.eclipsecs.core.CheckstyleBuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
</buildSpec>
19+
<natures>
20+
<nature>org.eclipse.jdt.core.javanature</nature>
21+
<nature>net.sf.eclipsecs.core.CheckstyleNature</nature>
22+
</natures>
23+
</projectDescription>

.settings/org.eclipse.jdt.core.prefs

Lines changed: 406 additions & 0 deletions
Large diffs are not rendered by default.

.settings/org.eclipse.jdt.ui.prefs

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
eclipse.preferences.version=1
2+
editor_save_participant_org.eclipse.jdt.ui.postsavelistener.cleanup=true
3+
formatter_profile=_ThreadlyStyle
4+
formatter_settings_version=12
5+
sp_cleanup.add_default_serial_version_id=true
6+
sp_cleanup.add_generated_serial_version_id=false
7+
sp_cleanup.add_missing_annotations=true
8+
sp_cleanup.add_missing_deprecated_annotations=false
9+
sp_cleanup.add_missing_methods=false
10+
sp_cleanup.add_missing_nls_tags=false
11+
sp_cleanup.add_missing_override_annotations=true
12+
sp_cleanup.add_missing_override_annotations_interface_methods=true
13+
sp_cleanup.add_serial_version_id=false
14+
sp_cleanup.always_use_blocks=true
15+
sp_cleanup.always_use_parentheses_in_expressions=false
16+
sp_cleanup.always_use_this_for_non_static_field_access=false
17+
sp_cleanup.always_use_this_for_non_static_method_access=false
18+
sp_cleanup.convert_to_enhanced_for_loop=false
19+
sp_cleanup.correct_indentation=false
20+
sp_cleanup.format_source_code=false
21+
sp_cleanup.format_source_code_changes_only=false
22+
sp_cleanup.make_local_variable_final=false
23+
sp_cleanup.make_parameters_final=false
24+
sp_cleanup.make_private_fields_final=true
25+
sp_cleanup.make_type_abstract_if_missing_method=false
26+
sp_cleanup.make_variable_declarations_final=false
27+
sp_cleanup.never_use_blocks=false
28+
sp_cleanup.never_use_parentheses_in_expressions=true
29+
sp_cleanup.on_save_use_additional_actions=true
30+
sp_cleanup.organize_imports=false
31+
sp_cleanup.qualify_static_field_accesses_with_declaring_class=false
32+
sp_cleanup.qualify_static_member_accesses_through_instances_with_declaring_class=true
33+
sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class=true
34+
sp_cleanup.qualify_static_member_accesses_with_declaring_class=false
35+
sp_cleanup.qualify_static_method_accesses_with_declaring_class=false
36+
sp_cleanup.remove_private_constructors=true
37+
sp_cleanup.remove_trailing_whitespaces=false
38+
sp_cleanup.remove_trailing_whitespaces_all=true
39+
sp_cleanup.remove_trailing_whitespaces_ignore_empty=false
40+
sp_cleanup.remove_unnecessary_casts=true
41+
sp_cleanup.remove_unnecessary_nls_tags=false
42+
sp_cleanup.remove_unused_imports=true
43+
sp_cleanup.remove_unused_local_variables=false
44+
sp_cleanup.remove_unused_private_fields=true
45+
sp_cleanup.remove_unused_private_members=false
46+
sp_cleanup.remove_unused_private_methods=true
47+
sp_cleanup.remove_unused_private_types=true
48+
sp_cleanup.sort_members=false
49+
sp_cleanup.sort_members_all=false
50+
sp_cleanup.use_blocks=true
51+
sp_cleanup.use_blocks_only_for_return_and_throw=false
52+
sp_cleanup.use_parentheses_in_expressions=false
53+
sp_cleanup.use_this_for_non_static_field_access=false
54+
sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=true
55+
sp_cleanup.use_this_for_non_static_method_access=false
56+
sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=true

BUILD_INSTRUCTIONS

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Threadly uses gradle to handle it's building, unit testing, and javadoc generation. This should make compiling on your own system very easy.
2+
3+
Use this documentation to download and install gradle: http://www.gradle.org/get-started
4+
5+
Once gradle is installed, you can compile (and run unit tests) simply by running:
6+
gradle build
7+
the compiled jar is located at: build/libs/
8+
javadocs are located at: build/docs/javadoc/
9+
unit test results are located at: build/reports/tests/
10+
unit test coverage results are located at: build/reports/emma/
11+
12+
-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
13+
14+
If you are using eclipse, you can import this project into eclipse easily. First checkout the code somewhere other than your workspace. Then from eclipse go File -> Import. Under "General" selec "Existing Projects into Workspace". Browse to the point where you checked out the code, select the Project and hit finish.
15+
16+
Once imported, if you want to contribute to the project, you should consider importing the Threadly coding style xml. This can be done by right clicking the project and going to "Properties". Then under "Java Code Style" select "Formatter". Check the box to "Enable project specific settings". Hit the import button and navigate to the threadly directory. Import the file: threadly/config/Eclipse_Coding_Style.xml and then hit "OK".
17+
18+
-=-=-=-=-=-=-=-==-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
19+
20+
If you plan to contribute to threadly, there are some important things to keep in mind:
21+
* Run the entire gradle build (which can be done just by running 'gradle build'). This ensures multiple things, first that the unit tests will pass, but also that the checkstyle will pass. We don't want to accept changes which have checkstyle regressions, or unit test failures. All tests should be passing.
22+
* If you want to contribute a new feature or a significant amount of code, please write unit tests for it. Part of this projects success will be the testability of the project. If you find this to be a road block, let me know, and we can work together to get new code/features under test.

0 commit comments

Comments
 (0)