Location: JWare Software » AntXtras » Documents » Properties
Properties
The table below contains the list of system properties AntXtras uses directly. All AntXtras owned properties are prefixed with “jware.antxtras.defaults.” For brevity this prefix is omitted in the table but you need to include it when you actually use the property. Read the Examples section to see how to define the fully qualified property name when calling Ant.
| V# | Property | Description | Defaults |
|---|---|---|---|
| 1 | noiselevel | Lets you alter the default message level used by AntXtras <show> and other echoing type tasks like <printenv>. Possible noise level values are: ‘debug’, ‘verbose’, ‘info’, ‘warning’, and ‘error’. | “info” |
| 1 | asserts.flag | Lets you turn off the AntXtras assertion task <assert>. If set “off” all assertions return true unconditionally— no actual checks are done. | “on” |
| 1 | haltiferror.flag | Lets you force AntXtras to signal an error when a variety of normally lenient tasks encounter some predefined condition or are otherwise unable to complete successfully. You can define both the default as well as feature-specific flags (see others listed below). | “off” |
| 2 | emptyvars.flag | Tells AntXtras that empty strings are allowed for variable values. Normally AntXtras interprets setting of a variable to the empty string the same as if you deleted the variable. | “off” |
| 1 | passwordfile | Tells AntXtras where your default cleartext basic username-password properties file lives. The named file should be formatted as a standard Java properties file, with the key as the user id and the value as the basic password for that user id. Depending on the component that needs the information, the default location used for this property can vary; however, most components use $HOME/.ant/run.passwords. | <default> |
| 1 | property.prefix | Lets you change the property prefix AntXtras uses to find fallback default default as read by the $default: function shortcut. | “default.” |
| 1 | loadfile.maxsize | Lets you define the maximum file size for any file loaded into AntXtras via components and function shortcuts like $loadfile:. | 1MB |
| 2 | haltiferror.funcuts.flag | Lets you force AntXtras to signal an error when a function shortcut is unable to determine its value successfully. Normally funcuts will not signal an error but will print warnings or whatever to the Ant console if they encounter any issues. | “off” |
| 3 | haltiferror.malformedproperties.flag | Lets you force AntXtras to signal an error if it detects a malformed property reference (for example: ‘${BROKEN’ where trailing ‘}’ is missing). | “off” |
| 1 | shortlocations.flag | Lets you control whether AntXtras will abbreviate its location strings to 41 chars. These location strings are supplied to the builtin AntXtras messages location parameters and various error messages. | “on” |
| 3 | allow.escape.flag | Lets you control whether AntXtras’ recursive property handler will process ‘\’ (back-slash) as an escape marker. If turned on, you can use back-slash to escape special characters like ‘$’. You can set this property at the global level or per-project. | “on” |
Examples
• To allow variables to contain the empty string enable the “defaults.emptyvars.flag” property. Usually you would unset a variable by setting its value to the empty string; setting this flag will prevent this behavior.
ant -Djware.antxtras.defaults.emptyvars.flag=on …
• To tell AntXtras where to find your cleartext default password file (format a standard Java properties file), set the “defaults.emptyvars.flag” property to file’s location (full path).
ant -Djware.antxtras.defaults.passwordfile=$HOME/etc/ant/.private/run.passwords …
• To tell AntXtras to fail if any function shortcut is unable to complete successfully enable the “defaults.haltiferror.funcuts.flag” property.
ant -Djware.antxtras.defaults.haltiferror.funcuts.flag=on …
