From dbd8a2e8fd8ae6b500e4184f2f572a7d7c88c2a4 Mon Sep 17 00:00:00 2001
From: Willem <willem.git.2015@forwardfire.net>
Date: Tue, 8 Sep 2015 22:39:28 +0200
Subject: [PATCH] start project stucture

---
 build.md                                      |  36 ++
 ff-unitxc-converter/pom.xml                   |   9 +
 .../unitxc/converter/UnitXConverter.java      |   8 +
 .../unitxc/converter/package-info.java        |   8 +
 pom.xml                                       | 390 ++++++++++++++++++
 readme.md                                     |  44 ++
 todo.md                                       |   2 +-
 7 files changed, 496 insertions(+), 1 deletion(-)
 create mode 100644 build.md
 create mode 100644 ff-unitxc-converter/pom.xml
 create mode 100644 ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/UnitXConverter.java
 create mode 100644 ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/package-info.java
 create mode 100644 pom.xml
 create mode 100644 readme.md

diff --git a/build.md b/build.md
new file mode 100644
index 0000000..5228fb5
--- /dev/null
+++ b/build.md
@@ -0,0 +1,36 @@
+# FF-UnitXC Building
+
+## Requirements
+
+* java sdk 1.8 or higher.
+* maven 3 or higher.
+* Commands are runned in project root folder.
+
+## Tests
+
+### Run tests normal
+mvn clean test
+
+### Run tests with jacoco
+mvn -Ptest-jacoco clean test
+
+## Create build artifacts
+mvn -Pbuild clean package
+
+## Change pom.xml versions
+mvn versions:set -DnewVersion=2.3.4-SNAPSHOT
+
+## Make release build
+mvn -Pbuild -Dusername=(scm_username) clean install release:clean release:prepare release:perform
+
+## Make site
+mvn -Ptest-jacoco clean install
+mvn -Pbuild-site site:site
+
+Optional add -DstagingDirectory=/tmp/fullsite
+And then manual upload.
+
+## Check for dependency-updates
+mvn versions:display-plugin-updates|grep ">"|uniq
+mvn versions:display-dependency-updates|grep ">"|uniq
+
diff --git a/ff-unitxc-converter/pom.xml b/ff-unitxc-converter/pom.xml
new file mode 100644
index 0000000..5680472
--- /dev/null
+++ b/ff-unitxc-converter/pom.xml
@@ -0,0 +1,9 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>net.forwardfire.unitxc</groupId>
+    <artifactId>ff-unitxc</artifactId>
+    <version>0.0.1-SNAPSHOT</version>
+  </parent>
+  <artifactId>ff-unitxc-converter</artifactId>
+</project>
\ No newline at end of file
diff --git a/ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/UnitXConverter.java b/ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/UnitXConverter.java
new file mode 100644
index 0000000..e86d05e
--- /dev/null
+++ b/ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/UnitXConverter.java
@@ -0,0 +1,8 @@
+package net.forwardfire.unitxc.converter;
+
+public interface UnitXConverter {
+
+	double convert(double value,String fromTypeId,String toTypeId);
+	
+	double convert(double value/*,UnitXType fromType,UnitXType toType*/);
+}
diff --git a/ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/package-info.java b/ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/package-info.java
new file mode 100644
index 0000000..78ad825
--- /dev/null
+++ b/ff-unitxc-converter/src/main/java/net/forwardfire/unitxc/converter/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * 
+ */
+/**
+ * @author willemc
+ *
+ */
+package net.forwardfire.unitxc.converter;
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
new file mode 100644
index 0000000..3e1003c
--- /dev/null
+++ b/pom.xml
@@ -0,0 +1,390 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<groupId>net.forwardfire.unitxc</groupId>
+	<artifactId>ff-unitxc</artifactId>
+	<version>0.0.1-SNAPSHOT</version>
+	<packaging>pom</packaging>
+	<name>FFUnitXC</name>
+	<description>Unit Xross Converter</description>
+	<inceptionYear>2015</inceptionYear>
+	<organization>
+		<name>ForwardFire.net</name>
+		<url>http://www.forwardfire.net/</url>
+	</organization>
+	<licenses>
+		<license>
+			<name>BSD License</name>
+			<url>license.txt</url>
+			<distribution>repo</distribution>
+			<comments>BSD 2-Clause License</comments>
+		</license>
+	</licenses>
+	<prerequisites>
+		<maven>3.0.1</maven>
+	</prerequisites>
+	<modules>
+	<module>ff-unitxc-converter</module>
+	</modules>
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<project.build.sourceVersion>1.8</project.build.sourceVersion>
+		
+		<!-- workaround for: [WARNING] 'reporting.plugins.plugin.version' for ... -->
+		<jacoco-maven-plugin.version>0.7.4.201502262128</jacoco-maven-plugin.version><!-- invalid format 1007: <version>0.7.5.201505241946</version> -->
+		<maven-javadoc-plugin.version>2.10.3</maven-javadoc-plugin.version>
+		<maven-project-info-reports-plugin>2.8</maven-project-info-reports-plugin>
+	</properties>
+	<dependencyManagement>
+		<dependencies>
+			<dependency>
+				<groupId>org.slf4j</groupId>
+				<artifactId>slf4j-api</artifactId>
+				<version>1.7.12</version>
+			</dependency>
+			<dependency>
+				<groupId>org.apache.commons</groupId>
+				<artifactId>commons-lang3</artifactId>
+				<version>3.4</version>
+			</dependency>
+			<dependency>
+				<groupId>junit</groupId>
+				<artifactId>junit</artifactId>
+				<version>4.12</version>
+			</dependency>
+			<dependency>
+				<groupId>ch.qos.logback</groupId>
+				<artifactId>logback-classic</artifactId>
+				<version>1.1.3</version>
+			</dependency>
+			<dependency>
+				<groupId>org.codehaus.sonar-plugins.java</groupId>
+				<artifactId>sonar-jacoco-listeners</artifactId>
+				<version>3.2</version>
+			</dependency>
+		</dependencies>
+	</dependencyManagement>
+	<dependencies>
+		<dependency>
+			<groupId>junit</groupId>
+			<artifactId>junit</artifactId>
+			<scope>test</scope>
+		</dependency>
+		<dependency>
+			<groupId>ch.qos.logback</groupId>
+			<artifactId>logback-classic</artifactId>
+			<scope>test</scope>
+		</dependency>
+	</dependencies>
+	<build>
+		<pluginManagement>
+			<plugins>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-antrun-plugin</artifactId>
+					<version>1.8</version>
+				</plugin>
+				<plugin>
+					<artifactId>maven-compiler-plugin</artifactId>
+					<version>3.0</version>
+					<configuration>
+						<encoding>${project.build.sourceEncoding}</encoding>
+						<source>${project.build.sourceVersion}</source>
+						<target>${project.build.sourceVersion}</target>
+					</configuration>
+				</plugin>
+				<plugin>
+					<artifactId>maven-source-plugin</artifactId>
+					<version>2.2.1</version>
+				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-site-plugin</artifactId>
+					<version>3.4</version>
+					<dependencies>
+						<dependency>
+							<groupId>org.apache.maven.doxia</groupId>
+							<artifactId>doxia-module-markdown</artifactId>
+							<version>1.6</version>
+						</dependency>
+					</dependencies>
+				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-javadoc-plugin</artifactId>
+					<version>${maven-javadoc-plugin.version}</version>
+				</plugin>
+				<plugin>
+					<groupId>org.jacoco</groupId>
+					<artifactId>jacoco-maven-plugin</artifactId>
+					<version>${jacoco-maven-plugin.version}</version>
+				</plugin>
+			</plugins>
+		</pluginManagement>
+	</build>
+	<profiles>
+		<profile>
+			<id>test-none</id>
+			<properties>
+				<skipTests>true</skipTests>
+			</properties>
+		</profile>
+		<profile>
+			<id>test-jacoco</id>
+			<build>
+				<plugins>
+					<plugin>
+						<artifactId>maven-surefire-plugin</artifactId>
+						<configuration>
+							<properties>
+								<property>
+									<name>listener</name>
+									<value>org.sonar.java.jacoco.JUnitListener</value>
+								</property>
+							</properties>
+						</configuration>
+					</plugin>
+					<plugin>
+						<groupId>org.jacoco</groupId>
+						<artifactId>jacoco-maven-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>jacoco-prepare-agent</id>
+								<phase>initialize</phase>
+								<inherited>true</inherited>
+								<goals>
+									<goal>prepare-agent</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+			<dependencies>
+				<dependency>
+					<groupId>org.codehaus.sonar-plugins.java</groupId>
+					<artifactId>sonar-jacoco-listeners</artifactId>
+					<scope>test</scope>
+				</dependency>
+			</dependencies>
+		</profile>
+		<profile>
+			<id>build</id>
+			<build>
+				<plugins>
+					<plugin>
+						<artifactId>maven-source-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>attach-sources</id>
+								<goals>
+									<goal>jar</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+		<profile>
+			<id>build-site</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-site-plugin</artifactId>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-project-info-reports-plugin</artifactId>
+						<version>${maven-project-info-reports-plugin}</version>
+						<dependencies><!-- fix for jdk8 -->
+							<dependency>
+								<groupId>org.apache.maven.shared</groupId>
+								<artifactId>maven-shared-jar</artifactId>
+								<version>1.1</version>
+								<exclusions>
+									<exclusion>
+										<groupId>org.apache.bcel</groupId>
+										<artifactId>bcel</artifactId>
+									</exclusion>
+								</exclusions>
+							</dependency>
+							<dependency>
+								<groupId>com.google.code.findbugs</groupId>
+								<artifactId>bcel-findbugs</artifactId>
+								<version>6.0</version>
+							</dependency>
+						</dependencies>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-antrun-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>copy-project-markdown</id>
+								<phase>generate-sources</phase>
+								<inherited>false</inherited>
+								<goals>
+									<goal>run</goal>
+								</goals>
+								<configuration>
+									<target>
+										<echo>Copy project markdown to site.</echo>
+										<copy verbose="true" file="readme.md" toFile="src/site/markdown/index.md" />
+										<copy verbose="true" file="todo.md" todir="src/site/markdown" />
+										<copy verbose="true" file="build.md" todir="src/site/markdown" />
+									</target>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+			<reporting>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-project-info-reports-plugin</artifactId>
+						<version>${maven-project-info-reports-plugin}</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<dependencyDetailsEnabled>false</dependencyDetailsEnabled>
+							<dependencyLocationsEnabled>false</dependencyLocationsEnabled>
+						</configuration>
+						<reportSets>
+							<reportSet>
+								<reports>
+									<!-- TODO: <report>cim</report> -->
+									<report>dependencies</report>
+									<report>dependency-convergence</report>
+									<report>dependency-info</report>
+									<report>dependency-management</report>
+									<!-- <report>distribution-management</report> -->
+									<!-- <report>help</report> -->
+									<!-- <report>index</report> -->
+									<report>issue-tracking</report>
+									<report>license</report>
+									<!-- TODO: <report>mailing-list</report> -->
+									<!-- <report>modules</report> -->
+									<report>plugin-management</report>
+									<report>plugins</report>
+									<!-- TODO:? <report>project-team</report> -->
+									<report>scm</report>
+									<report>summary</report>
+								</reports>
+							</reportSet>
+						</reportSets>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<version>${maven-javadoc-plugin.version}</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<quiet>true</quiet>
+							<linksource>true</linksource>
+							<maxmemory>512m</maxmemory>
+							<nohelp>true</nohelp>
+							<detectLinks>true</detectLinks>
+						</configuration>
+						<reportSets>
+							<reportSet>
+								<reports>
+									<report>aggregate</report>
+								</reports>
+							</reportSet>
+						</reportSets>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-pmd-plugin</artifactId>
+						<version>3.4</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<linkXref>true</linkXref>
+							<sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
+							<minimumTokens>100</minimumTokens>
+							<targetJdk>${project.build.javaVersion}</targetJdk>
+						</configuration>
+					</plugin>
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>findbugs-maven-plugin</artifactId>
+						<version>3.0.0</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<findbugsXmlOutput>true</findbugsXmlOutput>
+							<findbugsXmlWithMessages>true</findbugsXmlWithMessages>
+							<xmlOutput>true</xmlOutput>
+						</configuration>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-checkstyle-plugin</artifactId>
+						<version>2.15</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<enableRulesSummary>true</enableRulesSummary>
+							<configLocation>src/config/checkstyle.xml</configLocation>
+						</configuration>
+					</plugin>
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>taglist-maven-plugin</artifactId>
+						<version>2.4</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<tags>
+								<tag>@todo</tag>
+								<tag>@TODO</tag>
+								<tag>@deprecated</tag>
+								<tag>@help</tag>
+								<tag>@HELP</tag>
+								<tag>help</tag>
+								<tag>HELP</tag>
+								<tag>todo</tag>
+								<tag>TODO</tag>
+								<tag>fixme</tag>
+								<tag>FIXME</tag>
+								<tag>later</tag>
+								<tag>LATER</tag>
+								<tag>error</tag>
+								<tag>ERROR</tag>
+								<tag>temp</tag>
+								<tag>TEMP</tag>
+								<tag>mmm</tag>
+								<tag>MMM</tag>
+								<tag>???</tag>
+							</tags>
+						</configuration>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-surefire-report-plugin</artifactId>
+						<version>2.18.1</version>
+						<configuration>
+							<aggregate>true</aggregate>
+						</configuration>
+						<reportSets>
+							<reportSet>
+								<reports>
+									<report>report-only</report>
+								</reports>
+							</reportSet>
+						</reportSets>
+					</plugin>
+					<plugin>
+						<groupId>org.jacoco</groupId>
+						<artifactId>jacoco-maven-plugin</artifactId>
+						<version>${jacoco-maven-plugin.version}</version>
+						<configuration>
+							<aggregate>true</aggregate>
+							<goal>report</goal>
+						</configuration>
+					</plugin>
+				</plugins>
+			</reporting>
+		</profile>
+	</profiles>
+</project>
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..f4d4334
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,44 @@
+FF-UnitXC
+=========
+
+FF-UnitXC is a java8 library providing a cross unit converter.
+
+## Features
+
+* Many units provided.
+* Unit groups.
+* Unit tags.
+* Full metric system.
+* Imperial values.
+
+## Installation
+
+  Add maven deps;
+  
+    <dependency>
+      <groupId>net.forwardfire.unitxc</groupId>
+      <artifactId>ff-unitxc-converter</artifactId>
+      <version>0.0.1-SNAPSHOT</version>
+      <scope>compile</scope>
+    </dependency>
+
+## Files in this package
+
+* build.md              - Developer build commands.
+* license.txt           - The license of ff-unitxc.
+* pom.xml               - Maven specific build file.
+* readme.md             - This file.
+* todo.md               - Small todo list.
+* src                   - Site source.
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style.
+Add unit tests for any new or changed functionality. Style and test your code.
+
+## Release History
+
+### Version 0.0.1
+* First public release
+
+
diff --git a/todo.md b/todo.md
index 7cf8843..a2e22c6 100644
--- a/todo.md
+++ b/todo.md
@@ -1,4 +1,4 @@
-# FF-Unit-Converter TODO
+# FF-UnitXC TODO
 
 ## Current ERRATA