Module org.tquadrat.foundation.base
Package org.tquadrat.foundation.lang

Class CommonConstants

java.lang.Object
org.tquadrat.foundation.lang.CommonConstants
@ClassVersion(sourceVersion="$Id: CommonConstants.java 1134 2024-05-20 16:53:16Z tquadrat $") @UtilityClass public final class CommonConstants extends Object

This class provides a bunch of commonly used constants.

The constants are arranged into several categories.

  • Physical constants like gravity and speed of light.
  • XML constants, like often used names for entities and attributes.
  • Miscellaneous constants like the empty string or the null char.
Author:
Thomas Thrien (thomas.thrien@tquadrat.org)
Version:
$Id: CommonConstants.java 1134 2024-05-20 16:53:16Z tquadrat $
Since:
0.0.5
UML Diagram
UML Diagram for "org.tquadrat.foundation.lang.CommonConstants"⁠

UML Diagram for "org.tquadrat.foundation.lang.CommonConstants"

UML Diagram for "org.tquadrat.foundation.lang.CommonConstants"⁠

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Charset
    ASCII
    The reference to the ASCII character set.
    static final String
    CDATA_LEADIN
    The lead-in for a CDATA wrapped String: "<![CDATA["
    static final String
    CDATA_LEADOUT
    The lead-out for a CDATA wrapped String: "]]>"
    static final char
    CHAR_ELLIPSIS
    The horizontal ellipsis: … (&hellip;/&#8230;/&#x2026;/…).
    static final char
    CHAR_HYPHEN
    The hyphen character (&#8208;/&#x2010;/‐/HYPHEN).

    This is different from the character '-' (HYPHEN-MINUS), although it looks similar.
    static final char
    CHAR_NBSP
    The non-breaking space character (&#x00A0;/ ).
    static final char
    CHAR_NNBSP
    The small non-breaking space character (&#x202F;/ ).
    static final char
    CHAR_ZWNBSP
    The zero-width non-breaking space character; in fact, the 'word joiner' character that should be used instead of the original character.
    static final String
    CR
    The line terminator as defined by the underlying operating system.
    static final char
    DECIMAL_SEPARATOR
    The decimal separator for the current locale.
    static final String
    DEFAULT_APPLICATION_ID
    The default application id if nothing else could be used: "Default Program Main".
    static final CharSequence
    EMPTY_CHARSEQUENCE
    An empty char sequence.
    static final Object[]
    EMPTY_Object_ARRAY
    An empty array of Object objects.
    static final String
    EMPTY_STRING
    The empty string.
    static final String[]
    EMPTY_String_ARRAY
    An empty array of String instances.
    static final String
    ENV_JAVA_HOME
    The Java installation directory: "JAVA_HOME".
    static final int
    EOF
    The End-Of-File marker for streams: -1.
    static final BigDecimal
    GRAVITY_CONSTANT
    The Gravity constant: 6.672E-11 (N * m2)/(kg2).
    static final Predicate<? extends Object>
    IS_NULL
    Returns true if the provided reference is null otherwise returns false.
    static final Charset
    ISO8859_1
    The reference to the ISO-8859-1 character set.
    static final Predicate<? extends Object>
    NON_NULL
    Returns true if the provided reference is non-null otherwise returns false.
    static final int
    NOT_FOUND
    The index value indicating that nothing was found: -1.
    static final String
    NUL
    A String containing only NUL (the NULL_CHAR).
    static final char
    NULL_CHAR
    The null character.
    static final String
    NULL_STRING
    A String containing the sequence "null".
    static final String
    PROPERTY_APPLICATIONID
    The system property for the application id as used by the logging sub-system: "org.tquadrat.logging.applicationId".
    static final String
    PROPERTY_CLASSPATH
    The vested system property for the current class path: "java.class.path".
    static final String
    PROPERTY_CPUARCHITECTURE
    The vested system property for the architecture of the current CPU: "os.arch".
    static final String
    PROPERTY_FILE_ENCODING
    The vested system property for the file encoding used by the JVM: "file.encoding".
    static final String
    PROPERTY_HEADLESS
    The system property providing the flag that indicates whether the program is running in a headless mode, meaning that is does not have any kind of a graphical user interface: "java.awt.headless".
    static final String
    PROPERTY_IS_DEBUG
    The system property that is used to enable the debug mode: "isDebug".
    static final String
    PROPERTY_IS_TEST
    The system property that is used to enable the test mode: "isTest".
    static final String
    PROPERTY_JAVA_HOME
    The vested system property for the Java installation directory: "java.home".
    static final String
    PROPERTY_JAVA_RUNTIME
    The system property for the name of the Java runtime: "java.runtime.name".
    static final String
    PROPERTY_JAVA_VENDOR
    The vested system property for the Java vendor: "java.vendor".
    static final String
    PROPERTY_JAVA_VENDOR_URL
    The vested system property for the homepage URL of the Java vendor: "java.vendor.url".
    static final String
    PROPERTY_JAVA_VERSION
    The vested system property for the Java version: "java.version".
    static final String
    PROPERTY_JVM_NAME
    The vested system property for the name of the current JVM: "java.vm.name".
    static final String
    PROPERTY_JVM_VENDOR
    The vested system property for the name of the vendor for the current JVM: "java.vm.vendor".
    static final String
    PROPERTY_JVM_VERSION
    The vested system property for the version of the current JVM: "java.vm.version".
    static final String
    PROPERTY_LINE_SEPARATOR
    The vested system property for the line separator: "line.separator".
    static final String
    PROPERTY_LOGGING_CONFIG_CLASS
    The optional system property for the name of the class that provides the configuration the JDK logger: "java.util.logging.config.class".
    static final String
    PROPERTY_LOGGING_CONFIG_FILE
    The optional system property for the name of the configuration file for the JDK logger: "java.util.logging.config.file".
    static final String
    PROPERTY_MAIL_SESSION_DEBUG
    The optional system property for enabling java mail session debug: "javax.mail.Session.debug".
    static final String
    PROPERTY_MODULEPATH
    The (vested [?])
    static final String
    PROPERTY_NET_PROTOCOL_PKGS
    The system property for the name of the packages with URL protocol handlers: "java.protocol.handler.pkgs".
    static final String
    PROPERTY_OSNAME
    The vested system property for the name of the current operating system: "os.name".
    static final String
    PROPERTY_OSVERSION
    The vested system property for the version of the current operating system: "os.version".
    static final String
    PROPERTY_PREFS_ROOT_SYSTEM
    The system property for the location of the system preferences files on a UNIX/Linux system: "java.util.prefs.systemRoot".

    If not set, the location is /etc/, resulting to /etc/.java/.systemPrefs.

    If the default location is used, the respective folder has to be created by a user with root permissions; the files in there should have the rights 544, while the folder and its sub-folders should have 755.
    static final String
    PROPERTY_PREFS_ROOT_USER
    The system property for the location of the user preferences files on a UNIX/Linux system: "java.util.prefs.userRoot".

    If not set, the location is ~/, resulting to ~/.java/.userPrefs/.
    static final String
    PROPERTY_PREFS_SYNC
    The system property for the synchronisation interval of the preferences on a UNIX/Linux system, in seconds: "java.util.prefs.syncInterval".

    If not set, the interval is 30 seconds.
    static final String
    PROPERTY_RESOURCEBUNDLE_ENCODING
    The system property that is used to force the encoding for a PropertyResourceBundle: "java.util.PropertyResourceBundle.encoding".
    static final String
    PROPERTY_SAX_PARSER_FACTORY
    The system property for the class name of the SAX XML parser factory: "javax.xml.parsers.SAXParserFactory".
    static final String
    PROPERTY_SSL_KEYSTORE
    The system property for the name of the file with the SSL key store: "javax.net.ssl.keyStore".
    static final String
    PROPERTY_SSL_KEYSTORE_PASSWORD
    The system property for the password for the SSL key store: "javax.net.ssl.keyStorePassword".
    static final String
    PROPERTY_TEMPFOLDER
    The vested system property for the name of the temp folder that is used by the current user: "java.io.tmpdir".
    static final String
    PROPERTY_USER_COUNTRY
    The system property for the country code setting for the current user: "user.country".
    static final String
    PROPERTY_USER_DIR
    The vested system property for the name of the current working directory of the current user: "user.dir".
    static final String
    PROPERTY_USER_HOME
    The vested system property for the name of the home directory of the current user: "user.home".
    static final String
    PROPERTY_USER_LANG
    The system property for the language code setting the current user: "user.language".
    static final String
    PROPERTY_USER_NAME
    The vested system property for the name of the current user: "user.name".
    static final String
    PROPERTY_USER_TIMEZONE
    The system property for the time zone setting the current user: "user.timezone".
    static final BigDecimal
    SPEED_OF_LIGHT
    The speed of light in km per second = 299792.458 km/s.
    static final BigDecimal
    STANDARD_G
    The value for 1 G: 9.80665 m/(s2)
    static final char
    THOUSANDS_SEPARATOR
    The grouping separator for the current locale, used with large numbers to separate thousands.
    static final String
    THREADGROUP_MAIN
    The name of the main thread group: "main".

    This is the group of the main thread.
    static final String
    THREADGROUP_SYSTEM
    The name of the system thread group: "system".

    This is the group of several system threads and the parent thread group for the main thread group.
    static final long
    TIME_DELTA_BEGINGREGORIAN2BEGINEPOCH
    The time between 1582-10-15T00:00 (the start of the Gregorian calendar) and 1970-01-01T00:00 (the beginning of the "Epoch") in seconds: 12219292800L.
    static final BigDecimal
    TROPICAL_YEAR
    The length of a (tropical) year in days, according to SI: 365.242190517 d.
    static final String
    UNKNOWN_STRING
    A String containing the sequence "<UNKNOWN>".
    static final Charset
    US_ASCII
    The reference to the US-ASCII character set; this is the same as the ASCII character set.
    static final TimeZone
    UTC
    Deprecated, for removal: This API element is subject to removal in a future version.
    As the java.util.Date API is now obsolete, also the related classes, like java.util.TimeZone should be used no longer.
    static final Charset
    UTF8
    The reference to the UTF-8 character set.
    static final String
    XMLATTRIBUTE_Category
    The attribute name for an XML attribute holding a category of something: "category".
    static final String
    XMLATTRIBUTE_Class
    The attribute name for an XML attribute holding a class name: "class".
    static final String
    XMLATTRIBUTE_Date
    The attribute name for an XML attribute holding a date, usually without the time information: "date".
    static final String
    XMLATTRIBUTE_File
    The attribute name for an XML attribute holding a file name: "file".
    static final String
    XMLATTRIBUTE_Id
    The attribute name for the XML id attribute: "xml:id".
    static final String
    XMLATTRIBUTE_IdRef
    The attribute name for the XML idref attribute: "idref".
    static final String
    XMLATTRIBUTE_Language
    The attribute name for the XML language attribute: "xml:lang".
    static final String
    XMLATTRIBUTE_Name
    The attribute name for the XML name attribute: "name".

    Only names that follow exact rules for their character set can be stored in XML attributes, but free names have to be stored as XML elements.
    static final String
    XMLATTRIBUTE_NodeId
    The name for the node id XML attribute: "node".
    static final String
    XMLATTRIBUTE_PID
    The name for the PID XML attribute: "pid".
    static final String
    XMLATTRIBUTE_Reference
    The name for the reference XML attribute: "reference".
    static final String
    XMLATTRIBUTE_SequenceNumber
    The name for the sequence number XML attribute: "sequenceNumber".
    static final String
    XMLATTRIBUTE_Status
    The name for the status XML attribute: "status".
    static final String
    XMLATTRIBUTE_Time
    The attribute name for an XML attribute holding a time, usually without the date information: "time".
    static final String
    XMLATTRIBUTE_Timestamp
    The name for an XML attribute holding a date/time: "timestamp".
    static final String
    XMLATTRIBUTE_Type
    The name for an XML attribute holding a type, in the sense of a category or model, and usually not in the sense this term is used in the context of programming languages: "type".
    static final String
    XMLATTRIBUTE_UserId
    The name for the user id XML attribute: "userId".
    static final String
    XMLATTRIBUTE_Version
    The name for the version XML attribute: "version".
    static final String
    XMLATTRIBUTE_Whitespace
    The attribute name for the XML space attribute: "xml:space".
    static final String
    XMLELEMENT_Comment
    The element name for an XML element representing a comment: "comment".

    This is not an XML comment (they will be written as <!
    static final String
    XMLELEMENT_Date
    The element name for an XML element holding a date, usually without the time information: "date".
    static final String
    XMLELEMENT_Description
    The element name for an XML element representing a description of some kind: "description".
    static final String
    XMLELEMENT_Message
    The element name for an XML element containing a message: "message".
    static final String
    XMLELEMENT_Name
    The element name for an XML element representing a name of some kind: "name".

    Only names that follow exact rules for their character set can be stored in XML attributes, but free names have to be stored as XML elements.
    static final String
    XMLELEMENT_Text
    The element name for an XML element holding text: "text".
    static final String
    XMLELEMENT_Time
    The element name for an XML element holding a time, usually without the date information: "time".
    static final String
    XMLELEMENT_Timestamp
    The name for an XML element holding a date/time: "timestamp".
    static final ZoneId
    ZONE_UTC
    Deprecated.
    Use ZoneOffset.UTC instead.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    CommonConstants()
    No instance of this class is allowed.

  • Method Summary

    Methods inherited from class java.lang.Object

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