Project In-Line Help: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 10: Line 10:


The code that reads the help file is the self-contained class InLineHelp that can be placed in the <tt>util</tt> package of the project.
The code that reads the help file is the self-contained class InLineHelp that can be placed in the <tt>util</tt> package of the project.
=Implementation=


There's a novaordis-utilities version, in case the project already depends on novaordis-utilities:
There's a novaordis-utilities version, in case the project already depends on novaordis-utilities:
Line 15: Line 17:
{{External|https://github.com/NovaOrdis/novaordis-utilities/blob/master/src/main/java/io/novaordis/utilities/help/InLineHelp.java}}
{{External|https://github.com/NovaOrdis/novaordis-utilities/blob/master/src/main/java/io/novaordis/utilities/help/InLineHelp.java}}


=Example=
InLineHelp.java can be used as a starting point for a standalone implementation.
 
==Usage==


<syntaxhighlight lang='java'>
<syntaxhighlight lang='java'>
package ...;
try {


import java.io.BufferedReader;
    System.out.println(InLineHelp.get());
import java.io.IOException;
}
import java.io.InputStream;
catch(UserErrorException e) {
import java.io.InputStreamReader;
 
public class InLineHelp {
 
    // Constants -------------------------------------------------------------------------------------------------------
 
    public static final String HELP_FILE_NAME="help.txt";
 
    // Static ----------------------------------------------------------------------------------------------------------
 
    public static String get() throws UserErrorException {
 
        InputStream is = InLineHelp.class.getClassLoader().getResourceAsStream(HELP_FILE_NAME);
 
        if (is == null) {
 
            String msg = "no " + HELP_FILE_NAME + " file found on the classpath; this usually means that the application was not built or installed correctly";
            throw new UserErrorException(msg);
        }
 
        String help = "";
        BufferedReader br = null;
 
        try {
 
            br = new BufferedReader(new InputStreamReader(is));
            String line;
            while((line = br.readLine()) != null) {
 
                help += line + "\n";
            }
        }
        catch (Exception e) {
 
            throw new IllegalStateException(e);
        }
        finally {
 
            if (br != null) {
 
                try {
 
                    br.close();
                }
                catch(IOException e) {
 
                    System.err.println("warn: failed to close the input stream");
                }
            }
        }
 
        return help;
    }
 
    // Attributes ------------------------------------------------------------------------------------------------------
 
    // Constructors ----------------------------------------------------------------------------------------------------
 
    // Public ----------------------------------------------------------------------------------------------------------
 
    // Package protected -----------------------------------------------------------------------------------------------
 
    // Protected -------------------------------------------------------------------------------------------------------
 
    // Private ---------------------------------------------------------------------------------------------------------
 
    // Inner classes ---------------------------------------------------------------------------------------------------


    System.err.println(e.getMessage());
}
}
</syntaxhighlight>
</syntaxhighlight>


=Usage=
=Line Length=
 
103 characters.


<pre>
0123456789##########0123456789##########0123456789## 103 ###0123456789##########0123456789##########123
System.out.println(InLineHelp.get());
</pre>

Latest revision as of 07:46, 23 March 2019

Internal

Overview

The best mechanism so far to display in-line help is to maintain a help.txt file within the resources of the project, embed it into the root of the JAR artifact and dump it at stdout when needed.

Place the text help file ("help.txt" or "HELP.txt") in ./src/main/resources of the project, so it will be automatically bundled by Maven into the final JAR.

The code that reads the help file is the self-contained class InLineHelp that can be placed in the util package of the project.

Implementation

There's a novaordis-utilities version, in case the project already depends on novaordis-utilities:

https://github.com/NovaOrdis/novaordis-utilities/blob/master/src/main/java/io/novaordis/utilities/help/InLineHelp.java

InLineHelp.java can be used as a starting point for a standalone implementation.

Usage

try {

    System.out.println(InLineHelp.get());
}
catch(UserErrorException e) {

    System.err.println(e.getMessage());
}

Line Length

103 characters. 

0123456789##########0123456789##########0123456789## 103 ###0123456789##########0123456789##########123
Retrieved from "https://kb.novaordis.com/index.php?title=Project_In-Line_Help&oldid=56767"