From 70435f8908b7546f35c2da8a2801288fbb65d435 Mon Sep 17 00:00:00 2001
From: brinn <brinn>
Date: Sun, 29 Mar 2009 09:03:06 +0000
Subject: [PATCH] add: distribution file add: create javadoc add: license
information
SVN: 10406
---
base/build/build.xml | 33 ++-
base/dist/COPYING | 15 ++
base/dist/LICENSE | 203 ++++++++++++++++++
base/resource/dependency-structure.ddf | 5 +
.../cisd/base/exceptions/package.html | 13 ++
.../cisd/base/namedthread/package.html | 14 ++
.../ch/systemsx/cisd/base/unix/package.html | 12 ++
.../systemsx/cisd/base/utilities/package.html | 12 ++
8 files changed, 302 insertions(+), 5 deletions(-)
create mode 100644 base/dist/COPYING
create mode 100644 base/dist/LICENSE
create mode 100644 base/source/java/ch/systemsx/cisd/base/exceptions/package.html
create mode 100644 base/source/java/ch/systemsx/cisd/base/namedthread/package.html
create mode 100644 base/source/java/ch/systemsx/cisd/base/unix/package.html
create mode 100644 base/source/java/ch/systemsx/cisd/base/utilities/package.html
diff --git a/base/build/build.xml b/base/build/build.xml
index cd221dfdcb9..4965e6c64ad 100644
--- a/base/build/build.xml
+++ b/base/build/build.xml
@@ -6,10 +6,13 @@
<import file="../../build_resources/ant/build-common.xml" />
<project-classpath name="ecp" classes="${classes}" />
- <property name="mainfolder" value="base" />
+ <property name="mainfolder" value="cisd-base" />
<property name="jar.file" value="${dist}/cisd-base.jar" />
+ <property name="dist.file" value="${dist}/cisd-base" />
<property name="jar.test.file" value="${dist}/cisd-base-test.jar" />
<property name="src.zip.file" value="${dist}/cisd-base-src.zip" />
+ <property name="javadoc.zip.file" value="${dist}/cisd-base-javadoc.zip" />
+ <property name="original.dist" value="../${ant.project.name}/dist" />
<property name="nativesrc" value="${lib}/unix/native" />
<property name="nativeroot" value="${targets}/ant" />
<property name="native" value="${nativeroot}/native" />
@@ -20,8 +23,6 @@
<target name="ci" depends="build-common.ci, check-dependencies" />
- <target name="dist" depends="clean, jar, src-zip" />
-
<target name="jar" depends="compile">
<mkdir dir="${dist.common.lib}" />
<build-info revision="revision.number" version="version.number" clean="clean.flag" />
@@ -70,8 +71,7 @@
<zipfileset src="${lib}/commons-lang/commons-lang.jar" />
<zipfileset src="${lib}/commons-io/commons-io.jar" />
<manifest>
- <attribute name="Main-Class"
- value="ch.systemsx.cisd.base.unix.UnixTests" />
+ <attribute name="Main-Class" value="ch.systemsx.cisd.base.unix.UnixTests" />
<attribute name="Version" value="${version.number}" />
<attribute name="Build-Number"
value="${version.number} (r${revision.number},${clean.flag})" />
@@ -97,6 +97,29 @@
</recursive-jar>
</target>
+ <target name="doc">
+ <delete dir="targets/doc" />
+ <javadoc sourcepath="source/java"
+ packagenames="ch.systemsx.cisd.base.*"
+ classpath="../libraries/commons-lang/commons-lang.jar:../libraries/commons-io/commons-io.jar:../libraries/restrictionchecker/restrictions.jar"
+ destdir="targets/doc"
+ access="public" />
+ </target>
+
+ <target name="dist" depends="clean, jar, src-zip, doc">
+ <zip destfile="${javadoc.zip.file}" basedir="${targets}" includes="doc/**" />
+ <delete dir="${dist}/${mainfolder}" />
+ <move file="${jar.file}" todir="${dist}/${mainfolder}/lib" />
+ <move file="${src.zip.file}" todir="${dist}/${mainfolder}/src" />
+ <move file="${javadoc.zip.file}" todir="${dist}/${mainfolder}/doc" />
+ <copy todir="${dist}/${mainfolder}">
+ <fileset dir="${original.dist}"/>
+ </copy>
+ <zip destfile="${dist.file}-${version.number}.zip"
+ basedir="${dist}"
+ includes="${mainfolder}/**" />
+ </target>
+
<!--
// Runs the test suite 'tests.xml'.
-->
diff --git a/base/dist/COPYING b/base/dist/COPYING
new file mode 100644
index 00000000000..0bae4727c89
--- /dev/null
+++ b/base/dist/COPYING
@@ -0,0 +1,15 @@
+/*
+ * Copyright 2009 ETH Zuerich, CISD
+ *
+ * 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.
+ */
diff --git a/base/dist/LICENSE b/base/dist/LICENSE
new file mode 100644
index 00000000000..f820d4bd3a6
--- /dev/null
+++ b/base/dist/LICENSE
@@ -0,0 +1,203 @@
+/*
+ * Apache License
+ * Version 2.0, January 2004
+ * http://www.apache.org/licenses/
+ *
+ * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ *
+ * 1. Definitions.
+ *
+ * "License" shall mean the terms and conditions for use, reproduction,
+ * and distribution as defined by Sections 1 through 9 of this document.
+ *
+ * "Licensor" shall mean the copyright owner or entity authorized by
+ * the copyright owner that is granting the License.
+ *
+ * "Legal Entity" shall mean the union of the acting entity and all
+ * other entities that control, are controlled by, or are under common
+ * control with that entity. For the purposes of this definition,
+ * "control" means (i) the power, direct or indirect, to cause the
+ * direction or management of such entity, whether by contract or
+ * otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ * outstanding shares, or (iii) beneficial ownership of such entity.
+ *
+ * "You" (or "Your") shall mean an individual or Legal Entity
+ * exercising permissions granted by this License.
+ *
+ * "Source" form shall mean the preferred form for making modifications,
+ * including but not limited to software source code, documentation
+ * source, and configuration files.
+ *
+ * "Object" form shall mean any form resulting from mechanical
+ * transformation or translation of a Source form, including but
+ * not limited to compiled object code, generated documentation,
+ * and conversions to other media types.
+ *
+ * "Work" shall mean the work of authorship, whether in Source or
+ * Object form, made available under the License, as indicated by a
+ * copyright notice that is included in or attached to the work
+ * (an example is provided in the Appendix below).
+ *
+ * "Derivative Works" shall mean any work, whether in Source or Object
+ * form, that is based on (or derived from) the Work and for which the
+ * editorial revisions, annotations, elaborations, or other modifications
+ * represent, as a whole, an original work of authorship. For the purposes
+ * of this License, Derivative Works shall not include works that remain
+ * separable from, or merely link (or bind by name) to the interfaces of,
+ * the Work and Derivative Works thereof.
+ *
+ * "Contribution" shall mean any work of authorship, including
+ * the original version of the Work and any modifications or additions
+ * to that Work or Derivative Works thereof, that is intentionally
+ * submitted to Licensor for inclusion in the Work by the copyright owner
+ * or by an individual or Legal Entity authorized to submit on behalf of
+ * the copyright owner. For the purposes of this definition, "submitted"
+ * means any form of electronic, verbal, or written communication sent
+ * to the Licensor or its representatives, including but not limited to
+ * communication on electronic mailing lists, source code control systems,
+ * and issue tracking systems that are managed by, or on behalf of, the
+ * Licensor for the purpose of discussing and improving the Work, but
+ * excluding communication that is conspicuously marked or otherwise
+ * designated in writing by the copyright owner as "Not a Contribution."
+ *
+ * "Contributor" shall mean Licensor and any individual or Legal Entity
+ * on behalf of whom a Contribution has been received by Licensor and
+ * subsequently incorporated within the Work.
+ *
+ * 2. Grant of Copyright License. Subject to the terms and conditions of
+ * this License, each Contributor hereby grants to You a perpetual,
+ * worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ * copyright license to reproduce, prepare Derivative Works of,
+ * publicly display, publicly perform, sublicense, and distribute the
+ * Work and such Derivative Works in Source or Object form.
+ *
+ * 3. Grant of Patent License. Subject to the terms and conditions of
+ * this License, each Contributor hereby grants to You a perpetual,
+ * worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ * (except as stated in this section) patent license to make, have made,
+ * use, offer to sell, sell, import, and otherwise transfer the Work,
+ * where such license applies only to those patent claims licensable
+ * by such Contributor that are necessarily infringed by their
+ * Contribution(s) alone or by combination of their Contribution(s)
+ * with the Work to which such Contribution(s) was submitted. If You
+ * institute patent litigation against any entity (including a
+ * cross-claim or counterclaim in a lawsuit) alleging that the Work
+ * or a Contribution incorporated within the Work constitutes direct
+ * or contributory patent infringement, then any patent licenses
+ * granted to You under this License for that Work shall terminate
+ * as of the date such litigation is filed.
+ *
+ * 4. Redistribution. You may reproduce and distribute copies of the
+ * Work or Derivative Works thereof in any medium, with or without
+ * modifications, and in Source or Object form, provided that You
+ * meet the following conditions:
+ *
+ * (a) You must give any other recipients of the Work or
+ * Derivative Works a copy of this License; and
+ *
+ * (b) You must cause any modified files to carry prominent notices
+ * stating that You changed the files; and
+ *
+ * (c) You must retain, in the Source form of any Derivative Works
+ * that You distribute, all copyright, patent, trademark, and
+ * attribution notices from the Source form of the Work,
+ * excluding those notices that do not pertain to any part of
+ * the Derivative Works; and
+ *
+ * (d) If the Work includes a "NOTICE" text file as part of its
+ * distribution, then any Derivative Works that You distribute must
+ * include a readable copy of the attribution notices contained
+ * within such NOTICE file, excluding those notices that do not
+ * pertain to any part of the Derivative Works, in at least one
+ * of the following places: within a NOTICE text file distributed
+ * as part of the Derivative Works; within the Source form or
+ * documentation, if provided along with the Derivative Works; or,
+ * within a display generated by the Derivative Works, if and
+ * wherever such third-party notices normally appear. The contents
+ * of the NOTICE file are for informational purposes only and
+ * do not modify the License. You may add Your own attribution
+ * notices within Derivative Works that You distribute, alongside
+ * or as an addendum to the NOTICE text from the Work, provided
+ * that such additional attribution notices cannot be construed
+ * as modifying the License.
+ *
+ * You may add Your own copyright statement to Your modifications and
+ * may provide additional or different license terms and conditions
+ * for use, reproduction, or distribution of Your modifications, or
+ * for any such Derivative Works as a whole, provided Your use,
+ * reproduction, and distribution of the Work otherwise complies with
+ * the conditions stated in this License.
+ *
+ * 5. Submission of Contributions. Unless You explicitly state otherwise,
+ * any Contribution intentionally submitted for inclusion in the Work
+ * by You to the Licensor shall be under the terms and conditions of
+ * this License, without any additional terms or conditions.
+ * Notwithstanding the above, nothing herein shall supersede or modify
+ * the terms of any separate license agreement you may have executed
+ * with Licensor regarding such Contributions.
+ *
+ * 6. Trademarks. This License does not grant permission to use the trade
+ * names, trademarks, service marks, or product names of the Licensor,
+ * except as required for reasonable and customary use in describing the
+ * origin of the Work and reproducing the content of the NOTICE file.
+ *
+ * 7. Disclaimer of Warranty. Unless required by applicable law or
+ * agreed to in writing, Licensor provides the Work (and each
+ * Contributor provides its Contributions) on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied, including, without limitation, any warranties or conditions
+ * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ * PARTICULAR PURPOSE. You are solely responsible for determining the
+ * appropriateness of using or redistributing the Work and assume any
+ * risks associated with Your exercise of permissions under this License.
+ *
+ * 8. Limitation of Liability. In no event and under no legal theory,
+ * whether in tort (including negligence), contract, or otherwise,
+ * unless required by applicable law (such as deliberate and grossly
+ * negligent acts) or agreed to in writing, shall any Contributor be
+ * liable to You for damages, including any direct, indirect, special,
+ * incidental, or consequential damages of any character arising as a
+ * result of this License or out of the use or inability to use the
+ * Work (including but not limited to damages for loss of goodwill,
+ * work stoppage, computer failure or malfunction, or any and all
+ * other commercial damages or losses), even if such Contributor
+ * has been advised of the possibility of such damages.
+ *
+ * 9. Accepting Warranty or Additional Liability. While redistributing
+ * the Work or Derivative Works thereof, You may choose to offer,
+ * and charge a fee for, acceptance of support, warranty, indemnity,
+ * or other liability obligations and/or rights consistent with this
+ * License. However, in accepting such obligations, You may act only
+ * on Your own behalf and on Your sole responsibility, not on behalf
+ * of any other Contributor, and only if You agree to indemnify,
+ * defend, and hold each Contributor harmless for any liability
+ * incurred by, or claims asserted against, such Contributor by reason
+ * of your accepting any such warranty or additional liability.
+ *
+ * END OF TERMS AND CONDITIONS
+ *
+ * APPENDIX: How to apply the Apache License to your work.
+ *
+ * To apply the Apache License to your work, attach the following
+ * boilerplate notice, with the fields enclosed by brackets "[]"
+ * replaced with your own identifying information. (Don't include
+ * the brackets!) The text should be enclosed in the appropriate
+ * comment syntax for the file format. We also recommend that a
+ * file or class name and description of purpose be included on the
+ * same "printed page" as the copyright notice for easier
+ * identification within third-party archives.
+ *
+ * Copyright [yyyy] [name of copyright owner]
+ *
+ * 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.
+ */
diff --git a/base/resource/dependency-structure.ddf b/base/resource/dependency-structure.ddf
index 9677b095927..b463616bf42 100644
--- a/base/resource/dependency-structure.ddf
+++ b/base/resource/dependency-structure.ddf
@@ -1 +1,6 @@
{package} = ch.systemsx.cisd.base
+
+layer exceptions = ${package}.exceptions
+layer rest = ${package}.mdarray ${package}.namedthread ${package}.unix ${package}.utilities
+
+check layeringOf exceptions rest
\ No newline at end of file
diff --git a/base/source/java/ch/systemsx/cisd/base/exceptions/package.html b/base/source/java/ch/systemsx/cisd/base/exceptions/package.html
new file mode 100644
index 00000000000..b5b2cd12118
--- /dev/null
+++ b/base/source/java/ch/systemsx/cisd/base/exceptions/package.html
@@ -0,0 +1,13 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+ "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Exceptions.</title>
+</head>
+<body>
+<p>
+This package provides basic exceptions thrown by CISD software. Note that all exceptions are
+unchecked.
+</p>
+</body>
+</html>
\ No newline at end of file
diff --git a/base/source/java/ch/systemsx/cisd/base/namedthread/package.html b/base/source/java/ch/systemsx/cisd/base/namedthread/package.html
new file mode 100644
index 00000000000..d2a54d4999d
--- /dev/null
+++ b/base/source/java/ch/systemsx/cisd/base/namedthread/package.html
@@ -0,0 +1,14 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+ "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Named pool threads.</title>
+</head>
+<body>
+<p>
+This package provides <i>named pool threads</i> when using an
+{@code java.util.concurrent.ExecutorService}. This can be helpful in debugging and monitoring
+multi-threaded Java applications. Start having a look at the {@code NamedThreadPoolExecutor}.
+</p>
+</body>
+</html>
\ No newline at end of file
diff --git a/base/source/java/ch/systemsx/cisd/base/unix/package.html b/base/source/java/ch/systemsx/cisd/base/unix/package.html
new file mode 100644
index 00000000000..f8a97519adf
--- /dev/null
+++ b/base/source/java/ch/systemsx/cisd/base/unix/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+ "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Unix system calls.</title>
+</head>
+<body>
+<p>
+This package provides some basic (POSIX-compliant) Unix system calls.
+</p>
+</body>
+</html>
\ No newline at end of file
diff --git a/base/source/java/ch/systemsx/cisd/base/utilities/package.html b/base/source/java/ch/systemsx/cisd/base/utilities/package.html
new file mode 100644
index 00000000000..d7eda7fb3c8
--- /dev/null
+++ b/base/source/java/ch/systemsx/cisd/base/utilities/package.html
@@ -0,0 +1,12 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+ "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Basic utilities.</title>
+</head>
+<body>
+<p>
+This package provides some basic utility classes.
+</p>
+</body>
+</html>
\ No newline at end of file
--
GitLab