diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ccc8e57 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +target/ +.project +.classpath +.settings/ diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..63ac667 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,3 @@ +language: java +jdk: oraclejdk8 + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..68fceb3 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +# Changelog + +This file is used to record the changes with each release. + +## v0.1.0 + +- Initial release diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..21625df --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + 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/README.md b/README.md new file mode 100644 index 0000000..23cf6b4 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# commons-console + +[![Build Status: Linux](https://travis-ci.org/ciwise/commons-console.svg?branch=master)](https://travis-ci.org/ciwise/commons-console) + +## Introduction + +The commons-console project here is a JAR package library that is used to help with console output with command-line Java applications. More documentation will follow. + +## Usage + +The POM is deployed with the JAR to the Maven Central Repository and can therefore be used by just adding the following +snippet to your new project's pom.xml file.. + +```xml + + org.ciwise.commons + commons-console + ${version} + +``` + +You can find the latest version in GitHub releases. + +## Project Versioning and Updates + +The first publicly announced release will be 0.1.0. Following versions will always +use http://semver.org[semantic versioning]. Whenever one of the referenced +dependencies upgrades a major version, this project will upgrade major version by one. +The same process will be followed with minor as well as bugfix versions. + +We will also aim for a regular release schedule aiming initially for at least every 3 +months, ideally every month, as well as ad hoc releases whenever often used plugins +or dependencies provide important updates. + +More details about changes between versions are available from the +https://github.com/ciwise/commons-console/blob/master/CHANGELOG.md[changelog] + +## License + +Apache License, Version 2.0 + +For full text see LICENSE.txt file or http://www.apache.org/licenses/LICENSE-2.0 + +##Contributions + +Send a pull request or report issues on GitHub. Forking this project and sending +pull requests is preferred. + +## Development + +You can check for new plugins and versions with: + +``` +$ mvn versions:display-plugin-updates +$ mvn versions:display-property-updates +``` + +Deployment and releases are done using Maven on this project with the release to +reside in the Central Repository. + +- further command-line details will come after the 1.0.0 release. + +## Current Team +- David L. Whitehurst http://www.dlwhitehurst.com + +## Known projects using this library project + +This is appropriately licensed to be easily used by commercial and open source +projects alike. Please let us know if you are using this project and would like +to be listed here. + + diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..c60c089 --- /dev/null +++ b/pom.xml @@ -0,0 +1,45 @@ + + 4.0.0 + org.ciwise.commons + console-utility + 0.1.0 + CI Wise Console Utility Library + This simple library provides methods and utilities for command-line applications + + + org.ciwise + ciwise + 1.1.0 + + + + commons-api-${project.version} + + + + + + org.apache.maven.plugins + maven-source-plugin + 3.0.1 + + target + ${final.name} + true + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.4 + + + + + + + + + + diff --git a/src/main/java/org/ciwise/notification/ConsoleCharRunner.java b/src/main/java/org/ciwise/notification/ConsoleCharRunner.java new file mode 100644 index 0000000..8f872f7 --- /dev/null +++ b/src/main/java/org/ciwise/notification/ConsoleCharRunner.java @@ -0,0 +1,55 @@ +/** + * Copyright (c) CI Wise Inc. All rights reserved. http://www.ciwise.com + * The software in this package is published under the terms of the Apache + * version 2.0 license, a copy of which has been included with this distribution + * in the LICENSE.md file. + * + */ + +package org.ciwise.notification; + +/** + * This class simply prints the period (.) character across the console + * until someone sets running to true. + * + * @author David L. Whitehurst + * + */ +public class ConsoleCharRunner implements Runnable { + + /** + * A boolean flag for run method. + */ + boolean running = true; + + /** + * Modifiable run length of characters before newline is + * introduced + */ + int runlength = 45; + + /** + * String value to run across console, defaults to period + */ + String strChar = "."; + + /** + * This method inherits from parent Thread. + */ + public void run() { + int x = 0; + while (running) { + System.out.print(strChar); + x++; + if (x == 45) { + System.out.println(); + x=0; + } + try { + Thread.sleep(100); + } catch(InterruptedException ex) { + Thread.currentThread().interrupt(); + } + } + } +} diff --git a/src/main/java/org/ciwise/notification/ConsoleNotifier.java b/src/main/java/org/ciwise/notification/ConsoleNotifier.java new file mode 100644 index 0000000..b4d0d10 --- /dev/null +++ b/src/main/java/org/ciwise/notification/ConsoleNotifier.java @@ -0,0 +1,108 @@ +/** + * Copyright (c) CI Wise Inc. All rights reserved. http://www.ciwise.com + * The software in this package is published under the terms of the Apache + * version 2.0 license, a copy of which has been included with this distribution + * in the LICENSE.md file. + * + */ + +package org.ciwise.notification; + +import java.io.FileWriter; +import java.io.IOException; + +/** + * This class provides console output utilities for use in command-line Java applications + * @author David L. Whitehurst + * + */ +public class ConsoleNotifier { + + /** + * The singleton instance + */ + private static ConsoleNotifier instance = null; + + /** + * No default constructor + */ + private ConsoleNotifier() {} + + /** + * Static method to obtain singleton instance. + * @return a ConsoleNotifier instance + */ + public static ConsoleNotifier getInstance() { + if (instance == null) { + instance = new ConsoleNotifier(); + + } + return instance; + } + + /** + * This method outputs a header begin message, including the text label given. + * @param label + */ + public void header(final String label) { + System.out.println("================== " + "Begin - " + label + " =================="); + } + + /** + *This method outputs a footer end message, including the text label given. + * @param label + */ + public void footer(final String label) { + System.out.println(); + System.out.println("================== " + "End - " + label + " ===================="); + System.out.println(); + } + + /** + * This method outputs a wait message. + */ + public void beginProcess() { + System.out.println(); + System.out.println(" ... PLEASE WAIT FOR PROCESS TO COMPLETE ..."); + + } + + public static void main (String[] args) { + + final String process1 = "Google Drive Upload (JIRA)"; + + // begin console java task example + ConsoleNotifier.getInstance().header(process1); + ConsoleNotifier.getInstance().beginProcess(); + + /** + * create a thread to output periods across the screen to let you know + * the process is running. + */ + ConsoleCharRunner r = new ConsoleCharRunner(); + // optional (default ...) + r.strChar = "+"; + Thread t = new Thread(r); + t.start(); + int j = 0; // no. of periods + for (int x =0 ; x < 30000 ; x++){ + + // run some process + FileWriter fw; + + try { + fw = new FileWriter("c:/temp/x.out", true); + fw.write(j++); + fw.close(); + + } catch (IOException e) { + e.printStackTrace(); + } + } + + // tell thread to stop printing periods + r.running = false; + + ConsoleNotifier.getInstance().footer(process1); + } +} diff --git a/src/main/java/org/ciwise/notification/package-info.java b/src/main/java/org/ciwise/notification/package-info.java new file mode 100644 index 0000000..9cc0e04 --- /dev/null +++ b/src/main/java/org/ciwise/notification/package-info.java @@ -0,0 +1,13 @@ +/** + * Copyright (c) CI Wise Inc. All rights reserved. http://www.ciwise.com + * The software in this package is published under the terms of the Apache + * version 2.0 license, a copy of which has been included with this distribution + * in the LICENSE.md file. + * + */ + +/** + * @author David L. Whitehurst + * + */ +package org.ciwise.notification; \ No newline at end of file