de.frame4j.demos

Class HelloFrame4J

java.lang.Object

de.frame4j.util.App

de.frame4j.demos.HelloFrame4J

All Implemented Interfaces:

AttrSettable, TextHelper.MessageComponents, AppMBean, ComVar, UIInfo, ActionListener, EventListener

@MinDoc(copyright="Copyright 2005, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.39",
        lastModified="17.04.2021",
        usage="start as Java application (-? for help)",
        purpose="a demo and introductory application on Frame4J (the hello)")
public class HelloFrame4J
extends App

Hello World as Frame4J application.

This application is just greeting. It's effect is very like the notorious HelloWorld.java, usually doing
System.out.println("Guten Tag, Welt!")

This application HelloFrame4J demonstrates, that by usage of a good framework like Frame4J, you go farther by orders of magnitude with virtually no extra programming efforts.

To judge the compactness of the source code, see it without the comments (including this one), with no MinDoc annotation and without the "luxury" of the switchable showing of application start time.

With quite little extra effort (compared to a standard "naked" HellWorld in this toy example) one gets as Frame4J's gift

• (inter) nationalising,
• help output,
  
• comfortable evaluation and checking of command line parameters and configuration (.properties) files,
• provision of PrintWriters log and out (featuring the correct encoding even for the Windows console / command shell),
• optional output branching of log and out) to (log) files (see TeeWriter),
• and, and and ...

The spell word for all this is just extends App.

Insofar this toy applications's (HelloFrame4J's) source can be (and was very often) the starting point for real world Java applications. This procedure gave birth to server applications (based on Frame4J's predecessor) running for years in uninterrupted 7d24h service.


Hint on .properties: To this application (source: HelloFrame4J.java) belongs (as integral part) a .properties file named HelloFrame4J.properties.
An extra properties file HelloFrame4J_pl.properties demonstrates the schema to bring extra languages in. In this case of Polish (Cześ ćświat!) setting
chcp 1250
set activeCodePage=Cp1250
might be necessary to display the greeting correctly. (The usual Cp850 will fail.)
For the the handling of console font sets or "code pages" for Window's command shell see the script cp.bat as an example.

All public fields (non inherited public object variables) of a HelloFrame4J object are properties, controlling the application's working mode. They may be (automatically) set by Prop.


© Copyright 2005, 2009 Albrecht Weinert

See Also:

App, Prop

Nested Class Summary

Nested classes/interfaces inherited from interface de.frame4j.util.ComVar

ComVar.Impl

Field Summary

Fields

Modifier and Type	Field and Description
String	param1 The first normal (non -option) or word parameter.
boolean	showDateTime Show also date and time.

Fields inherited from class de.frame4j.util.App

ano, appBase, appIO, appStartTime, appStartTimeMS, args, argsOrig, bgColor, err, fullClassName, help, icon, log, mainThread, myClass, myFrame, name, out, outMode, packName, prop, retCode, runFlag, shortClassName, title, verbose, verbosity

Fields inherited from interface de.frame4j.util.ComVar

AUTHOR, BLANK_STRING, cons, CONSOL_ENCODING, COPYRIGHT, D, D_NaN, D_NegInf, D_PosInf, EMPTY_INT_A, EMPTY_STRING, FILE_ENCODING, FRW_CLLD, FS, FSS, H, hasCons, HOST_IP, HOST_IPv4, HOST_NAME, INIT_ERROR, JAR_ENCODING, JH, JOB_DONE_OK, JRL, LOG_OUT_ERROR, M, MAIN_THREAD_EXC, NO_BYTES, NO_CLASSES, NO_DOUBLES, NO_OBJECTS, NO_PARS_ERROR, NO_STRINGS, NOT_WINDOWS, ON_PI, ONE_DAY, ONE_HOUR, ONE_LEAP_YEAR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ONE_YEAR, OS, PROG_NAME, PROG_SHORT, PS, RUNTIME, S, SHY, UD, UL, UL_UR_da, UR

Fields inherited from interface de.frame4j.net.AttrSettable

ILLEGAL_TYPE, ILLEGAL_VALUE, NO_ATTRIBUTE, NO_KNOWN_ATTRIBUTE, NO_VALUE, OK, retVtext

Constructor Summary

Constructors

Constructor and Description
HelloFrame4J()

Method Summary

Modifier and Type	Method and Description
int	doIt() HelloFrame4J's working method.
static void	main(String[] args) HelloFrame4J's start method.
boolean	parsePartial() HelloFrame4J wants only partial parameter parsing by Prop.

Methods inherited from class de.frame4j.util.App

actionPerformed, allowNoPropertiesFile, clientOrder, condHelpLog, connect, errMeld, errMeld, errorExit, errorExit, errorText, extraPropertiesFile, formMessage, formMessage, formMessage, getAbout, getAboutText, getActTime, getAppLogger, getAppStartTime, getArgs, getAuthor, getCopyright, getDbLogger, getExecTimeMs, getExecTimeMsL, getExecTimeString, getHelp, getHelpText, getIcon, getLanguage, getLogHandler, getMessageComponent, getMessageComponentsLength, getMyFrame, getName, getNameWithVersDate, getOutMode, getProp, getPurpose, getStartTime, getStateString, getTheCloser, getTitle, getUsage, getVerbose, getVerbosity, getVersDate, go, go, go, haveIcon, isDebug, isHelp, isHelpLog, isNormal, isRunFlag, isSilent, isTest, isVerbose, logVerbose, logVerbose, makeStatusTextEnd, makeStatusTextStart, messageFormat, normalExit, performeAction, queueAction, regAsStdMBean, repExc, setAboutText, setAttribute, setAttribute, setAuthor, setBgColor, setCodePages, setCopyright, setHelp, setLogOut2, setName, setOutMode, setOutMode, setPurpose, setTitle, setUsage, setVerbose, setVerbose, setVerbosity, setVerbosity, setVersDate, stop, threeLineEndMsg, toString, twoLineEndMsg, twoLineStartMsg, valueLang, valueLang, wakeMainThread

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.frame4j.net.AttrSettable

retVtext

Field Detail

showDateTime

public boolean showDateTime

Show also date and time.

Set according to HelloFrame4J.properties.

default: true

See Also:

Prop.setFields(Object), PropMapHelper.setField(Object, String, String)

param1

public String param1

The first normal (non -option) or word parameter.

Constructor Detail

HelloFrame4J

public HelloFrame4J()

Method Detail

parsePartial

public final boolean parsePartial()

HelloFrame4J wants only partial parameter parsing by Prop.

Overrides:

parsePartial in class App

Returns:

false except when made by the make'n go constructor App.App(String[])

main

public static void main(String[] args)

HelloFrame4J's start method.

This is the static standard start for an application (forced on us by the Java standard). In the case of a Frame4J based application extending App directly or indirectly it just creates an object of its own App derived class and calls a suitable go() method.
The "real work" is done in doIt().

Exit code 0: successfully run.
Exit code ComVar.INIT_ERROR: start or parameter evaluation problem.
Exit > 0: problems

Parameters:

args - the command line arguments passed by the platform to the JVM (java.exe), here just forwarded

doIt

public int doIt()

HelloFrame4J's working method.

Here the world is greeted.

Available languages are: de, en, fr, it, pt, es, nl, da
and for this demo pl by grace of a supplementary HelloFrame4J_pl.properties.

Optionally one gets a start up report with time and date (avoidable by -noTime). For test or demo (switched on by -debug) a list of all properties, as set by loaded .properties files and command line parameters, will be output first.

Specified by:

doIt in class App

Returns:

the exit code; 0 means OK

See Also:

Prop, App.go(String[]), App.go(String[], String, CharSequence), App.mainThread