unkrig.de - User contributions [en]

Html2txt

2024-05-02T17:00:46Z

Aunkrig: /* Change Log */

A tool to convert HTML documents into plain text.

For example this HTML code

[[File:Main.main.jpg]]

is rendered like this:

[[File:usage.txt.jpg]]

For a complete description of the supported HTML inline elements, see
<span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_INLINE_ELEMENTS here]</span>.

For a complete description of the supported HTML block elements, see
<span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_BLOCK_ELEMENTS here]</span>.

== Motivation ==

The goal was to generate the "usage" page that a command line tool usually prints when you invoke it with a "<tt>-help</tt>" or "<tt>--help</tt>" option, rather than maintain it manually (e.g. in the form of "<tt>println()</tt>" statements in the code).

The chosen solution is to put a big DOC comment before the "<tt>main()</tt>" method, generate an HTML page with JAVADOC, convert that into a plain text file, put it into the application's JAR file and copy its contents to STDOUT when the user want to see it.

The command line version of <tt>html2txt</tt> itself uses that technique, and you can see the results above.

== Download ==

You can download the latest version of the runnable JAR file [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=html2txt&v=LATEST&c=jar-with-dependencies here].

== Limitations ==

Since the tool uses the JRE's built-in XML parser, it supports "numeric character references" (like "&#252;" for "Ü"), but not "named HTML character entity references" (like "&Uuml;" for "Ü").

For the same reason, the HTML markup in the DOC comments must be "well-formed", i.e. all start tags must be matched by an end tag (like "<code><li>...</li></code>"), and void tags must end with a slash, like "<code><br /></code>".

== Usage ==

=== Command line tool ===

see [http://html2txt.unkrig.de/Main.main(String%5b%5d).html here].

=== ANT task ===

see [http://html2txt.unkrig.de/antdoc/index.html here].

=== Library ===

see [http://html2txt.unkrig.de/javadoc/index.html the JAVADOC].

=== Source Code ===

see [https://github.com/aunkrig/html2txt the source code repository].

== Change Log ==

; Version 1.0.3, 2018-10-29:
:* Added vertical alignment (e.g. "<div align='justify'>").
:* Made the tests robust against the platform-dependent line separators.
:* Cleaned up the MAINDOC generation.

; Version 1.0.2, 2016-11-25:
:* Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".

; Version 1.0.1, 2016-11-07:
:* Resurrected Java 6 compatibility.

== License ==

<code>html2txt</code> is published under the "[[New BSD License]]".

== Contact ==

If you have issues, don't hesitate to [https://sourceforge.net/p/html2txt/tickets/ submit a ticket].

To discuss in public, check the [https://sourceforge.net/p/html2txt/discussion/ forum] and/or subscribe to it (envelope icon).

Cs-doclet

2024-05-02T16:47:40Z

Aunkrig: /* Source code */

== Abstract ==

Cs-doclet is a [http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/ JAVADOC doclet] that generates the metadata files for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ eclipse-cs] from annotations and [http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJGIJB doc tags] in the source code of your checks and filters.

This doclet is useful only for authors of CheckStyle extensions, like [[Cs-contrib.unkrig.de|cs-contrib]].

== Intended audience ==

This tool is useful for the development of [http://checkstyle.sourceforge.net/ CheckStyle] checks and filters, and for their integration in [http://eclipse-cs.sourceforge.net/ eclipse-cs] and [http://www.mediawiki.org/wiki/MediaWiki MediaWiki].

== Extending CheckStyle ==

CheckStyle comes with an API to [http://checkstyle.sourceforge.net/writingchecks.html extend] it with custom checks and filters. Here is a completely useless, yet typical example of a custom check:

'''File "src/com/pany/cs/checks/ColorCheck.java":'''
package com.pany.cs.checks;

import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

public
class ColorCheck extends Check {

public void
setColor(String value) { this.color = value; }
private String color = "Yellow";

@Override public int[]
getDefaultTokens() { return new int[] { TokenTypes.ANNOTATION }; }

@Override public void
visitToken(DetailAST ast) { this.log(ast, "theColorIs", this.color); }
}

The CheckStyle extension API supports internationalization be means of "messages.properties" files:

'''File "src/com/pany/cs/checks/messages.properties":'''
theColorIs = The color is ''{0}''

'''File "src/com/pany/cs/checks/messages_de.properties":'''
theColorIs = Die Farbe ist ''{0}''

To make use of this check, you'd write a "CheckStyle configuration file"

'''File "checkstyle-config.xml":'''
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">
<property name="severity" value="warning" />
<module name="TreeWalker">
<module name="com.pany: ColorCheck">
<property name="color" value="blue" />
</module>
</module>
</module>

, and execute CheckStyle on a target project, e.g. on the example project itself:

$ javac -d bin src/com/pany/cs/checks/ColorCheck.java
$ java -classpath '<span style="color:red">bin</span>;path/to/checkstyle-6.1-all.jar' \
> com.puppycrawl.tools.checkstyle.Main \
> -c checkstyle-config.xml \
> -r src
Starting audit...
C:\dev\EclipseWS\de.unkrig.cs-contrib\foo\src\com\pany\cs\checks\ColorCheck.java:14:5: warning: The color is 'blue'
C:\dev\EclipseWS\de.unkrig.cs-contrib\foo\src\com\pany\cs\checks\ColorCheck.java:17:5: warning: The color is 'blue'
Audit done.
$

(We get the two warnings because there are two "@Override" annotations in the code.)

Obviously, the Java code and the "messages.properties" files must be kept in sync with the Java code at all times, which is naturally very error-prone.

Cs-doclet facilitates the task by generating the "messages.properties" file from annotations in the source code:

'''File "src/com/pany/cs/checks/MyCheck.java":'''
package com.pany.cs.checks;

import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

public
class ColorCheck extends Check {

<span style="color:red">@Message("The color is ''{0}''")
private static final String MESSAGE_KEY_THE_COLOR_IS = "theColorIs";</span>

public void
setColor(String value) { this.color = value; }
private String color = "Yellow";

@Override public int[]
getDefaultTokens() { return new int[] { TokenTypes.ANNOTATION }; }

@Override public void
visitToken(DetailAST ast) { this.log(ast, <span style="color:red">MESSAGE_KEY_THE_COLOR_IS</span>, this.color); }
}

To generate the "messages.properties" file, you'd run JAVADOC with the cs-doclet and the "-messages.properties-dir" command line option:
$ javadoc \
> <span style="color:red">-doclet de.unkrig.doclet.cs.CsDoclet</span> \
> <span style="color:red">-docletpath "path/to/cs-doclet.jar;bin;path/to/checkstyle-6.1-all.jar;path/to/net.sf.eclipsecs.core-6.1.jar"</span> \
> <span style="color:red">-messages.properties-dir src</span> \
> -sourcepath src \
> -classpath ../net.sf.checkstyle-6.1/checkstyle-6.1/checkstyle-6.1-all.jar \
> com.pany.cs.checks
Loading source files for package com.pany.cs.checks...
Constructing Javadoc information...
$

Notice that both "checkstyle.jar" and "net.sf.eclipsecs-core.jar" must be on the "-docletpath".

The generated "src/com/pany/cs/checks/messages.properties" file looks like this:

# This file was generated by the CS doclet; see http://cs-doclet.unkrig.de/

# Custom check messages, in alphabetical order.

# --------------- com.pany: ColorCheck ---------------
<span style="color:red">theColorIs</span> = <span style="color:red">The color is ''{0}''</span>

And voilà! All the messages are where they belong: In the source code.

== Integrating with eclipse-cs ==

When you integrate your checks with eclipse-cs, then you learn that you have to write two more metadata files:

'''File "checkstyle-metadata.xml":'''
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE checkstyle-metadata PUBLIC
"-//eclipse-cs//DTD Check Metadata 1.1//EN"
"http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd">
<checkstyle-metadata>

<rule-group-metadata name="%Whitespace.group" priority="999">
<rule-metadata
internal-name="com.pany.cs.checks.ColorCheck"
parent="TreeWalker"
name="%ColorCheck.name"
>
<alternative-name internal-name="com.pany.cs.checks.ColorCheck" />
<description>%ColorCheck.desc</description>

<property-metadata
name="color"
datatype="String"
default-value="Yellow"
>
<description>%ColorCheck.color</description>
</property-metadata>
<message-key key="theColorIs" />
</rule-metadata>
</rule-group-metadata>
</checkstyle-metadata>

'''File "checkstyle-metadata.properties":'''
Whitespace.group = Whitespace
ColorCheck.name = com.pany: ColorCheck
ColorCheck.desc =\
A completely useless check which merely prints a (localizable) message each \
time it encounters an annotation.
ColorCheck.color = A completely useless check parameter.

Tedious, isn't it? Well, you can tell cs-doclet to also generate ''these'' files from annotations (and doc comments):

'''File "src/com/pany/cs/checks/MyCheck.java":'''
// File "src/com/pany/cs/ColorCheck.java".

package com.pany.cs.checks;

import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

import de.unkrig.csdoclet.StringRuleProperty;
import de.unkrig.csdoclet.Rule;

/**
* <span style="color:red">A completely useless check which merely prints a</span>
* <span style="color:red">(localizable) message each time it encounters an annotation.</span>
*/
<span style="color:red">@Rule(
group = "%Whitespace.group",
groupName = "Whitespace",
name = "com.pany: ColorCheck",
parent = "TreeWalker"
)</span>
public
class ColorCheck extends Check {

@Message("The color is ''{0}''")
private static final String MESSAGE_KEY_THE_COLOR_IS = "theColorIs";

/**
* <span style="color:red">A completely useless check parameter</span>.
*/
<span style="color:red">@StringRuleProperty(defaultValue = DEFAULT_COLOR)</span>
public void
setColor(String value) { this.color = value; }

private String color = <span style="color:red">DEFAULT_COLOR</span>;

<span style="color:red">private static final String DEFAULT_COLOR = "Yellow";</span>

@Override public int[]
getDefaultTokens() { return new int[] { TokenTypes.ANNOTATION }; }

@Override public void
visitToken(DetailAST ast) { this.log(ast, MESSAGE_KEY_THE_COLOR_IS, this.color); }
}

$ javadoc \
> -doclet de.unkrig.doclet.cs.CsDoclet \
> -docletpath "path/to/cs-doclet.jar;bin;path/to/checkstyle-6.1-all.jar;path/to/net.sf.eclipsecs.core-6.1.jar" \
> <span style="color:red">-checkstyle-metadata.properties-dir src</span> \
> <span style="color:red">-checkstyle-metadata.xml-dir src</span> \
> -messages.properties-dir src \
> -sourcepath src \
> -classpath ../net.sf.checkstyle-6.1/checkstyle-6.1/checkstyle-6.1-all.jar \
> com.pany.cs.checks
Loading source files for package com.pany.cs.checks...
Constructing Javadoc information...
$

And you'll get:

'''File "src/com/pany/cs/checks/checkstyle-metadata.properties":'''
# This file was generated by the CS doclet; see http://cs-doclet.unkrig.de/

# Rule groups:
<span style="color:red">Whitespace.group</span> = <span style="color:red">Whitespace</span>

# Custom checks, in alphabetical order.

# --------------- <span style="color:red">com.pany: ColorCheck</span> ---------------

<span style="color:red">ColorCheck.name</span> = <span style="color:red">com.pany: ColorCheck</span>
<span style="color:red">ColorCheck.desc</span> =\
<span style="color:red">A completely useless check which merely prints a (localizable) message each time it encounters an annotation.</span>
<span style="color:red">ColorCheck.color</span> = <span style="color:red">A completely useless check parameter.</span>

'''File "src/com/pany/cs/checks/checkstyle-metadata.xml":'''
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE checkstyle-metadata PUBLIC
"-//eclipse-cs//DTD Check Metadata 1.1//EN"
"http://eclipse-cs.sourceforge.net/dtds/checkstyle-metadata_1_1.dtd">
<checkstyle-metadata>





<rule-group-metadata name="<span style="color:red">%Whitespace.group</span>" priority="999">
<rule-metadata
internal-name="<span style="color:red">com.pany.cs.checks.ColorCheck</span>"
parent="<span style="color:red">TreeWalker</span>"
name="<span style="color:red">%ColorCheck.name</span>"
>
<alternative-name internal-name="<span style="color:red">com.pany.cs.checks.ColorCheck</span>" />
<description><span style="color:red">%ColorCheck.desc</span></description>

<property-metadata
name="<span style="color:red">color</span>"
datatype="<span style="color:red">String</span>"
default-value="<span style="color:red">Yellow</span>"
>
<description><span style="color:red">%ColorCheck.color</span></description>
</property-metadata>
<message-key key="theColorIs" />
</rule-metadata>
</rule-group-metadata>
</checkstyle-metadata>

== Javadoc-like documentation ==

Typically, you will also want to publish human-readable documentation for your checks and filters, which is more or less identical with the text in the eclipse-cs metadata files. This is also possible with the "-d" command line option:

$ javadoc \
> -doclet de.unkrig.doclet.cs.CsDoclet \
> -docletpath "path/to/cs-doclet.jar;bin;path/to/checkstyle-6.1-all.jar;path/to/net.sf.eclipsecs.core-6.1.jar" \
> -d ./csdoc \
> -sourcepath src \
> -classpath ../net.sf.checkstyle-6.1/checkstyle-6.1/checkstyle-6.1-all.jar \
> com.pany.cs.checks
Loading source files for package com.pany.cs.checks...
Constructing Javadoc information...
$

This will generate a Javadoc-like HTML documentation for all checks and filters that are declared in the given Java packages.

And you're done!

== Summary ==

Before, you had to write one Java file and four more or less redundant metadata files per check; now you merely have to throw in a few annotations and doc comments and generate all four metadata files from the source code

== Source code ==

The source code for the plug-in is here:

https://github.com/aunkrig/doclet-cs
https://github.com/aunkrig/doclet-cs-annotation

== Change log ==

; Version 1.1.2 2022-01-27
:* Ignore all standard doclet options; this makes this doclet more robust in environments that absolutely want to pass "standard options" to JAVADOC, e.g. APACHE MAVEN.
:* Render a list of related rules in the description of each quickfix.
:* Render a list of related quickfixes in the description of each check.

; Version 1.1.1 2022-01-25
:* Added the "-help" command line option. (Previously, the MAINDOC document generated by the POM was unused.)
:* "-messages.properties-dir" command line option worked only when option "-checkstyle-metadata.properties" was also given.

; Version 1.1.0 2020-01-22
:* Type of annocation attribute "Rule.quickfixes" changed from "Class[]" to "String[]" to avoid compile-time dependencies from the CS extension to the ECLIPSECS wrapper of the CS extension.
:* Added support for CheckStyle version 8.5. (CheckStyle Version 8.2 had breaking changes!)

ANT doclet

2024-05-02T16:41:19Z

Aunkrig: /* Change Log */

Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.

The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Antology]] antlib:

[[File:antdoc-ant-contrib.png|border|500px]]

== Usage ==

<html>

<h3>Doclet command line options:</h3>

<dl>
<dt><code>-d</code> <var>directory</var></dt>
<dd>Where to create documentation in HTML format (optional).
<p>
The effective file name is:
</p>
<p>
<code><dest-dir>/<ant-type-group>/<ant-type>.html</code>
</p>
<p>
The default destination directory is "<code>.</code>".
</p></dd>
<dt><code>-splitindex</code></dt>
<dd>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index
entries that start with non-alphabetical characters.</dd>
<dt><code>-docencoding</code> <var>charset</var></dt>
<dd>The charset to use when writing the HTML files. The default is the JVM default charset, "${file.encoding}".</dd>
<dt><code>-charset</code> <var>name</var></dt>
<dd>The HTML character set for this document.</dd>
<dt><code>-doctitle</code> <var>html-text</var></dt>
<dd>The title to place near the top of the overview summary file. The text specified in the title tag is placed as
a centered, level-one heading directly beneath the top navigation bar. The title tag can contain HTML tags and
white space.</dd>
<dt><code>-header</code> <var>text</var></dt>
<dd>The header text to be placed at the top of each output file. The header is placed to the right of the upper
navigation bar. The header can contain HTML tags and white space.</dd>
<dt><code>-footer</code> <var>text</var></dt>
<dd>The footer text to be placed at the bottom of each output file. The footer value is placed to the right of the
lower navigation bar. The footer value can contain HTML tags and white space.</dd>
<dt><code>-top</code> <var>text</var></dt>
<dd>The text to be placed at the top of each output file.</dd>
<dt><code>-bottom</code> <var>text</var></dt>
<dd>The text to be placed at the bottom of each output file. The text is placed at the bottom of the page,
underneath the lower navigation bar. The text can contain HTML tags and white space.</dd>
<dt><code>-quiet</code></dt>
<dd>Suppress normal output.</dd>
<dt><code>-notimestamp</code></dt>
<dd>Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
This is useful when you want to run the javadoc command on two source bases and get the differences between diff
them, because it prevents time stamps from causing a diff (which would otherwise be a diff on every page).
The time stamp includes the javadoc command release number.</dd>
<dt><code>-antlib-file</code> <var>file</var></dt>
<dd>The ANTLIB file to parse, see <a href="https://ant.apache.org/manual/Types/antlib.html">the documentation of
the ANTLIB concept</a>.</dd>
<dt><code>-antlib-resource</code> <var>name</var></dt>
<dd>The name of an ANTLIB resource to parse, see <a href="https://ant.apache.org/manual/Types/antlib.html">the
documentation of the ANTLIB concept</a>.</dd>
<dt><code>-link</code> <var>external-documentation-url</var></dt>
<dd>See <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDEDJFI">the JAVADOC
tool documentation for the "-link" command line option</a>.</dd>
<dt><code>-linkoffline</code> <var>external-documentation-url</var> <var>package-list-location</var></dt>
<dd>See <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDFIIJH">the JAVADOC
tool documentation for the "-linkofflin" command line option</a>.</dd>
<dt><code>-tag</code> <var>spec</var></dt>
<dd>For compatibility with the standard JAVADOC doclet; ignored.</dd>
<dt><code>-theme</code> JAVA7|JAVA8</dt>
<dd>Which style sheets and resources to use.</dd>
<dt><code>-sourcepath</code> <var>source-path</var></dt>
<dd>Takes also effect for loading ANTLIB resources.</dd>
<dt><code>-classpath</code> <var>class-path</var></dt>
<dd>Takes also effect for loading ANTLIB resources.</dd>
<dt><code>-windowtitle</code> <var>text</var></dt>
<dd>See <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBIEEI">the JAVADOC
tool documentation for the "-windowtitle" command line option</a>.</dd>

</dl>

<h3>Supported tags:</h3>

<p>
The following block tags may appear in the DOC comment of a class declaration that maps to an ANT type:
</p>
<dl>
<dt><code>{@ant.typeGroupName <var>type-group-name</var>}</code></dt>
<dd>
The name of the "type group" that the type belongs to, e.g. "<code>Task</code>".
</dd>
<dt><code>{@ant.typeGroupSubdir <var>dir-name</var>}</code></dt>
<dd>
The name of the subdirectory that contains the documentation of all ANT types of the type group; e.g.
"<code>tasks</code>".
</dd>
<dt><code>{@ant.typeGroupHeading <var>text</var>}</code></dt>
<dd>
The heading to display above the list of types; e.g. "<code>Tasks</code>".
</dd>
<dt><code>{@ant.typeTitleMf <var>message-format</var>}</code></dt>
<dd>
The message format to use to render the heading on each type details page; e.g. <code>"Task
&quot;&lt;{0}&gt;&quot;"</code>
</dd>
<dt><code>{@ant.typeHeadingMf <var>message-format</var>}</code></dt>
<dd>
The message format to use to render the title (i.e. the tooltip) of the heading on each type details page;
e.g. <code>"Task &amp;quot;&lt;code>&lt;{0}&gt;&lt;/code>&amp;quot;"</code>
</dd>
<dt><code>{@ant.group <var>group-name</var>}</code></dt>
<dd>
Attributes (or subelements) with equal <var>group-name</var> are grouped, and the <var>group-name</var> is rendered as a heading above the group.
</dd>
<dt><code>{@ant.subelementOrder inheritedFirst}</code></dt>
<dd>
Enforces that the subelements <em>inherited</em> from superclasses appear <em>before</em> the non-inherited.
The default is that the subelements in their "natural" order.
</dd>
</dl>
</html>

== Features ==

=== Basics ===

The doclet parses the "[https://github.com/aunkrig/antology/blob/master/antology/src/main/resources/de/unkrig/antology/ant.xml ANTLIB file]" of your ANTLIB to identify all the tasks, types, chainable readers etc. that the ANTLIB implements. Then it finds the attribut setter and subelement adder methods, just like ANT would do. Eventually it generates one HTML page for each task, type, chainable reader etc., plus various overview, summary, index and frameset pages; very similar to what the standard JAVADOC servlet does for a set of Java classes.

References to attribute setter and subelement adder methods are not rendered as "<Code>setFoo(String)</code>" and "<code>addPerson(Person)</code>", but like "<code>foo=...</code>" and "<code><person></code>".

Links to the various standard ANT types are recognized and rendered appropriately.

=== Related attributes ===

Sometimes you want to document multiple attributes ''together'', i.e. have only ''one'' description. To get that, write a doc comment with a description for the ''first'' setter, and for the other setters a doc comment with a ''sole'' @see tag that refers to the first setter. Here is an [http://antology.unkrig.de/antdoc/tasks/swingLookAndFeel.html#attributes_summary example].

=== Grouping of attributes and subelements ===

Attribute setter methods ("<code>set*()</code>") and subelement adder methods ("<code>add*()</code>", "<code>addConfigured*()</code>" and "<code>create*()</code>") can have a "<code>@ant.group</code> ''group-name''" block tag in their DOC comment. If at least one attribute setter method (resp. subelement adder method) has such a block tag, then the attributes (resp. subelements) are grouped by ''group-name'', and each group gets a respective heading, and the subelements without a <code>@ant.group</code> go into a group "Other".

=== Attribute value documentation ===

The ANT doclet visualizes the meaning, the possible values and the default values for each attribute. The meaning is derived from the method parameter type and name (or the <code>@ant.valueExplanation</code> block tag); the possible values (for enums) from the enum constants, and the (optional) default value from the method parameter type and the <code>@ant.defaultValue</code> block tag.

The <code>@ant.mandatory</code> block tag appends " (mandatory)" to the attribute description title.

=== Custom type groups ===

The ANT doclet analyzes the types and, based on the interfaces they implement, assigns them to "type groups", which will later appear in the left-hand-side frame. The well-known type groups are: "Tasks", "Resource collections", "Chainable readers", "Conditions and "Other types". It is also possible to assign types to your own custom type groups, by adding the following block tags to the type:

/**
* This type lives in a custom "type group". For this example, we re-use the values for the "Tasks" type group -- please use your own instead.
*
* @ant.typeGroupSubdir tasks
* @ant.typeGroupName Task
* @ant.typeGroupHeading Tasks
* @ant.typeTitleMf Task "&lt;{0}&gt;"
* @ant.typeHeadingMf <code>&lt;{0}&gt;</code>
*/

=== Ordering of subelements ===

If an ANT type (e.g. a task) or a subelement has this block tag

/**
* @ant.subelementOrder inheritedFirst
*/

, then the subelements inherited from superclasses and interfaces are rendered ''before'' the subelements of the actual class. The default behavior is the other way round.

== Resources ==

The doclet JAR file is [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=doclet-ant&v=LATEST&c=jar-with-dependencies here].

Find the source code for the doclet [https://github.com/aunkrig/doclet-ant here].

== Change Log ==

; Version 1.0.7, 2018-10-29:
:* Fixed up links to attribute setters of ad hoc-subelements.
:* ttribute default values: Display control characters as "&#xxx;", e.g.: delimiter="delimiter-characters|, 	
"
:* Fixed one NPE.
:* Added the "-tag" command line option for compatibility with the standard JAVADOC doclet.

; Version 1.0.6, 2016-12-12:
:* Command line processing is now "@CommandLineOption"-based.

; Version 1.0.5, 2016-11-25:
:* ANTLIB includes are now looked up through the javadoc sourcepath AND the javadoc classpath.
:* Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".

; Version 1.0.4, 2016-11-15:
:* The "-doctitle" command line option had no effect.

; Version 1.0.3, 2016-11-07:
:* Allow for multiple "-antlib-file" options.
:* Also process NESTED antlib files.

== License ==

The ANT doclet is available under the terms of the "new BSD license":

Copyright (c) 2015, Arno Unkrig
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of no-template nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Commons.unkrig.de

2024-05-02T16:04:23Z

Aunkrig: /* Change Log */

<tt>de.unkrig.commons</tt> is a versatile Java™ library that implements many useful container and utility classes.
It extends and integrates seamlessly with the standard JDK library.

== Overview ==

<tt>de.unkrig.commons</tt> is structured in several modules who's names are aligned to the related packages in the JDK libraries.

== Module Details ==

=== commons-asm ===

Helper classes that are useful in the context of [http://forge.ow2.org/projects/asm/ ASM], a Java bytecode manipulation library.

''Resources:''
[http://commons.unkrig.de/commons-asm/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=pom Maven POM]

=== commons-doclet ===

Helper classes that are useful for those who write [http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html doclets].

''Resources:''
[http://commons.unkrig.de/commons-asm/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=pom Maven POM]

=== commons-file ===

Functionality for
[http://commons.unkrig.de/commons-file/apidocs/index.html?de/unkrig/commons/file/fileprocessing/package-summary.html processing]
or
[http://commons.unkrig.de/commons-file/apidocs/index.html?de/unkrig/commons/file/filetransformation/package-summary.html transforming]
trees of directories, files, compressed and archive files, and even nested compressed and archive files. Supports more than a dozen compression and archive formats.

''Resources:''
[http://commons.unkrig.de/commons-file/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-file&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-file&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-file&v=LATEST&e=pom Maven POM]

=== commons-io ===

Functionality around byte streams and readers/writers, e.g. for converting a byte stream into a hex dump, or formatting an XML document.

''Resources:''
[http://commons.unkrig.de/commons-io/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=pom Maven POM]

=== commons-junit4 ===

Assertions etc. for those who write tests with JUNIT 4.

''Resources:''
[http://commons.unkrig.de/commons-io/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=pom Maven POM]

=== commons-lang ===

* Utility classes for [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/ExceptionUtil.html exceptions], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/ThreadUtil.html threads] and [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/RunnableUtil.html runnables]
* [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/package-summary.html "Protocol" interfaces] like [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Producer.html Producer], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Consumer.html Consumer], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Predicate.html Predicate], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Transformer.html Transformer]

''Resources:''
[http://commons.unkrig.de/commons-lang/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-lang&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-lang&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-lang&v=LATEST&e=pom Maven POM]

=== commons-math ===

[http://commons.unkrig.de/commons-math/apidocs/index.html?de/unkrig/commons/math/package-summary.html de.unkrig.commons.math]: A linear congruential generator; a [http://commons.unkrig.de/commons-math/apidocs/index.html?de/unkrig/commons/math/Sequences.html random sequence generator]

''Resources:''
[http://commons.unkrig.de/commons-math/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-math&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-math&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-math&v=LATEST&e=pom Maven POM]

=== commons-net ===

* [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/http/package-summary.html HTTP] and [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/ftp/package-summary.html FTP] servers and clients
* Various networking tools like [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/tool/tcpmon/package-summary.html TCPMON], [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/tool/ftpmon/package-summary.html FTPMON], [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/tool/telnet/package-summary.html TELNET]

''Resources:''
[http://commons.unkrig.de/commons-net/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-net&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-net&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-net&v=LATEST&e=pom Maven POM]

=== commons-nullanalysis ===

* Annotations and utility classes for ECLIPSE annotation-base "null analysis".

''Resources:''
[http://commons.unkrig.de/commons-nullanalysis/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-nullanalysis&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-nullanalysis&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-nullanalysis&v=LATEST&e=pom Maven POM]

=== commons-reflect ===

Various utilities for Java's reflection API.

''Resources:''
[http://commons.unkrig.de/commons-reflect/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-reflect&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-reflect&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-reflect&v=LATEST&e=pom Maven POM]

=== commons-text ===

* An [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/expression/ExpressionEvaluator.html expression evaluator]
* A small framework for creating [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/scanner/package-summary.html scanners] and [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/parser/package-summary.html parsers]
* A [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/pattern/Glob.html Glob] class that combines the widely known elements of UNIX file name globbing with the power of regular expressions

''Resources:''
[http://commons.unkrig.de/commons-text/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-text&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-text&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-text&v=LATEST&e=pom Maven POM]

=== commons-util ===

* [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/CommandLineOptions.html CommandLineOptions] makes parsing and documentation of command line options (e.g. for "<code>public static void main(String[])</code>") easy; see the [[CommandLineOptions tutorial|tutorial]].
* [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/TimeTable.html TimeTable] parses and implements a CRON-like specification string
* Various [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/filter/package-summary.html filters], [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/handler/package-summary.html handlers] and [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/formatter/package-summary.html formatters] for <tt>java.util.logging</tt>
* The [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/SimpleLogging.html SimpleLogging] facility for easy integration of <tt>java.util.logging</tt> within command line tools

''Resources:''
[http://commons.unkrig.de/commons-util/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-util&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-util&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-util&v=LATEST&e=pom Maven POM]

== Source Code ==

The source code is available through GITHUB:

https://github.com/aunkrig/commons/

== License ==

COMMONS.UNKRIG.DE is published under the "[[New BSD License]]".

== Change Log ==

; Version 1.2.19 2024-03-14:
:* CommandLineOptions: Improved the handling of sub-options: These can now be terminated with "--"; unknown sub-options are now detected realiably (and not taken as following option arguments).
:* Add a variant of "FileTransformations.transfor(String[] args...)" that treats file name "-" as STDIN or STDOUT.
:* FtpClient: Added missing FTP operations.
:* FtpClient: Fixed up data connection handling.
:* CommandLineOptions: Do NOT consider command line arguments starting with dash+space as an option.
:* CommandLineOptions: Improved the handling of suboption arguments that look like options (i.e. begin with one or two dashes and a letter).

; Version 1.2.18 2022-12-28:
:* de.unkrig.commons.file.resourceprocessing.ResourceProcessings: Added "ResourceProcessings.STDIN_URL".
:* de.unkrig.commons.file.resourceprocessing.ResourceProcessings: ZZDIFF can now handle "-" (stdin) as one of its two inputs.
:* de.unkrig.commons.text.scanner: Added "setInput(input, int start, int end)" for scanning partial strings.
:* de.unkrig.commons.text.expression.ExpressionEvaluator: Added "parsePart(String spec, int[] offset, int end)" for parsing partial strings.
:* de.unkrig.commons.text.pattern.ExpressionMatchReplacer: Added "\Q...\E" and "\Q...".
:* ExpressionMatchReplacer.parseExt(): Added "\xhh", "\uhhhh", "\x{h...h}" and "normal" escapes ("\r", "\n", asf.).

; Version 1.2.17 2022-07-22:
:* d.u.c.lang.Characters: Small fixes of character classes for JRE 8 backwards compatibility.
:* d.u.c.lang.PrettyPrinter: Fixed one NPE in "PrettyPrinter.getPrettyClassName()" (handling of classes without a canonical name).
:* d.u.c.lang.StringUtil: Added multi-needle variants of "boyerMooreHorspoolIndexOf()", e.g. "needle1|[Nn]eedle2".
:* Added tests for "MapUtil.lazyMap()".
:* d.u.c.util.collections.MapUtil: Created a brother method "MapUtil.lazyMap(Map<K, Producer<? extends V>> valueGetters)" for "MapUtil.lazyMap(Map<K, Function<? super I, ? extends V>> valueGetters, @Nullable final I in)".
:* d.u.c.util.collections.IteratorUtil: Added "IteratorUtil.concat(List<Iterator>)".
:* d.u.c.util.CommandLineOptionException: Include "toString()" of the cause into the OptionProcessingException's message, because the cause's "getMessage()" is often not verbose enough.
:* d.u.c.text.expression.ExpressionEvaluator: Implemented the special attributes "_attributes", "_properties", "_staticAttributes" and "_staticProperties".
:* d.u.c.text.expression.ExpressionEvaluator: Arrays are now silently pretty-printed in all places.
:* Added "ObjectUtil.arrayToString(Object)".
:* d.u.c.lang.protocol.ConsumerUtil: Moved "Grep.lineCounter()" to "ConsumerUtil".
:* d.u.c.text.pattern.PatternUtil: Added to the "patternFinderWriter()" method family some more with a "Runnable flush" parameter.
:* d.u.c.text.pattern.Finders: Added to the "patternFinder()" method family some more with a "Runnable flush" parameter.
:* d.u.c.lang.protocol.Functions: Added "Functions.constant(O)".
:* d.u.c.io.ConsumingWriter: Added the "ConsumingWriter".
:* d.u.c.text.pattern.Substitutor: The Substitutor is now based on the Finders.patternFinder().
:* d.u.c.text.pattern.PatternUtil: The object returned by "replacementStringMatchReplacer()" didn't have a proper "toString()" method.
:* d.u.c.file.org.apache.commons.compress.archivers: "ArchiveFormat.forArchiveOutputStream(ArchiveOutputStream)" didn't work in all cases.

; Version 1.2.16 2022-03-21:
:* Iff the field "Throwable.message" cannot be made accessible, print a useful warning message on STDERR instead of throwing an exception.
:* Gave up on Java 6 compatibility... now Java 8.
:* Added "setPassword()", in addition to the system property.
:* Gave up on Java 6 compatibility... now Java 8.
:* Added "MavenUtil".
:* Reverted the commit of "Glob.java" of 2021-12-01 19:22: "%" is *not* a valid suffix; otherwise all compressed contents (e.g. "dir/file.gz%") would match a pattern like "***foo".
:* Added test case for "FileProcessings.starterFile(String regex)".
:* Added "ContentProcessings.glob()".
:* Added "PatternUtil.constantPrefix()".
:* Added "FileProcessings.glob()".
:* Added "OutputStreams.newOverwritingFileOutputStream(File)": "$xyz" was handled differently from "${xyz}" and caused an NPE.
:* Added "AbstractParser.readEnum()".
:* Gave up on backwards compatibility with Java 6 and 7 (removed substitutes for java.util.Base64).
:* Added "Readers.readFully()".
:* Added "InputStreams.readFully()".
:* Set "useTransparentBounds(true)" when scanning, so token regexes can use lookaheads and lookbehinds.
:* Eliminated the terrible hack where STORED zip archive entries were silently transformed into DEFLATED (because STORED entries need a correct SIZE and CRC, and these were difficult to calculate). Implemented this with a temporary storage using an "elastic pipe".
:* Added "OutputStreams.updatesChecksum(final Checksum checksum) => OutputStream".
:* The substitution count was wrong (*2 value).
:* Typo in "elasticPipe()" caused an IllegalStateException.
:* Added "ArchiveFormat.getCompressionMethod(ArchiveEntry)", which returns a string representation of the compression method used for the archive entry.
:* Generating TAR archives: The "long file mode" (determines the handling of file names longer than 100 characters) can now be controlled with a system property "TarArchiveFormat.longFileMode"; the default is now "GNU" (and not, as before, "ERROR").
:* Added "Numbers.unsignedCompareToByte/Short/Int/Long()".
:* Added the "Relation" interface and the "Relations" utility class.

; Version 1.2.15 2020-11-06:
:* commons-file: Implemented decryption of encrypted 7ZIP archives with a sysem property "sevenZInputFilePassword".
:* commons-file: Directory processing: JRE11+MS WINDOWS replace colons (#003A) in member names with #F03A, for whatever reason.
:* commons-net: For method CONNECT, the second word of the request line is not a URI, but only an authority (host:port).
:* commons-file: Handle AR archive entriy with empty name: Silently rename it to "__ROOT".
:* commons-net: Fixed one resource leak.
:* commons-file: "apache.commons.compress" no longer seems to miss the dependency on "org.tukaani" -- removed the workaround.
:* commons-file: Augmented all content processing with an optional "lastModifiedDate" parameter.
:* commons-file: Added (read-only) support for the "rpm" archive format. (An PM file is actually a compressed CPIO archive preceeded by some binary metadata.)
:* commons-util: Added "MapUtil.lazyMap()".
:* commons-text: Added "Notation.Phrase.size()" and "Notation.Phrase.get()".
:* commons-io: Fixed an endless loop in "MarkableFileInputtream.skip()".
:* commons-io: Fixed a ConcurrentModificationException.
:* commons-text: Replaced single quotes in many messages with (the typographically more correct) double quotes.
:* commons-util: Wrap exceptions that occur during option processing with the new "OptionProcessingException" (instead of an AssertionError).
:* commons-io: Added "Writers.autoFlushing()" and "OutputStreams.autoFlushing()". Added "Readers.wye(Reader, Writer)" and marked "WyeReader" as deprecated.
:* commons-io, commons-lang: Added tons of "? super" and "? extends" clauses.

; Version 1.2.14 2019-10-11:
:* Fixed an IllegalArgumentException in "Pattern2.compile(String, int)" and "Glob.compile(String, int)".
:* StringStream: Made "next()" and "consume()" public.
:* OptionalMethods: All methods get an additional first parameter "@Nullable String message", which, if non-null, is used for the UnsupportedOperationException.
:* Added "XmlUtil.parse(DocumentBuilder, InputStream, String publicId, String encoding)".
:* Added "Writers.tee(Writer... delegates)".
:* ArArchiveFormat: Catch an NPE thrown by ArArchiveInputStream.
:* ArArchiveFOrmat: Catch a NumberFormatException in ArArchiveInputStream.
:* Work around "ZipException: uncompressed size is required for STORED method when not writing to a file"
:* commons.doclet.Html: Changed fragment style from Java 7 to Java 8+.
:* ResourceProcessings: "isFile()" did not decode %xx escape sequences in URLs.
:* commons.lang.Comparators: Added "Comparators.keyComparator()" and ".valueComparator()".
:* FileProcessings.directoryProcessor(): The "pathPredicate" was applied wrong for *files* (as opposed to directories). As a result, "zzgrep --include '***.class'" did not match .class files *in archives*.
:* InputStreams: Added "EventCounter", "ExponentiallyLoggingEventCounter" and "InputStreams.statisticsInputStream()" for real-time IO statistics.
:* Optimize archive file and compressed file reading by replacing small file READs with large file READs.
:* Added input stream statistics in "CompressUtil" and "FileContentsProcessor".
:* Fatal bug in "ConsumerUtil.head()" fixed!
:* Added "commons.lang.protocolTuple2", "Tuple3" and "Tuple4".
:* ExpressionMatchReplacer: Replaced "imports" with "singleImports" and "onDemandImports".
:* ExpressionEvaluator: Added scanning of MULTI-LINE C-style comments. Added scanning of C++-style comments.
:* Added "de.unkrig.commons.file.resourceprocessing", in symmetry with "fileprocessing" and "contentsprocessing", to process *resources* (designated by URLs) in addition to files and InputStreams.
:* commons.file: Compressed file names and compressed contents paths are now suffixed with '%' (instead of '!') to circumvent problems with "Glob"'s directory prefix mechanism.
:* Java 9 added "@Override public final CharBuffer CharBuffer.rewind() { ..." -- leads easily to a "NoSuchMethodError: java.nio.CharBuffer.rewind()Ljava/nio/CharBuffer"; a cast to "Buffer" is the workaround.
:* Added "LineUtil.lineAndColumnTracker()".
:* Added "Readers.onFirstChar()" and "Readers.trackLineAndColumn(Reader)".
:* Added "Writers.onFirstChar()" and "Writers.trackLineAndColumn(Writer)".
:* Removed unnecessary dependency on "de.unkrig.commons:commons-junit4".
:* CommandLineOptions: Convert "any" to InetAddr "null" ("wildcard address").

; Version 1.2.13 2018-11-23:
:* In analogy with the "Substitutor", the new "Search" class finds pattern matches in a sequence of chunks in a "sliding" manner. Instead of a "match replacer", it invokes a "match handler".
:* Breaking change: A "match replacer" is no longer a "FunctionWhichThrows<Matcher, String, EX>", but a "FunctionWhichThrows<MatchResult, String, EX>".
:* Added support for HTTP method "OPTIONS".
:* Refined the logic that checks for "Socket closed" exceptions.

; Version 1.2.12 2018-10-29:
:* ChunkedInputStream: Reading of blank line after last chunk was missing.
:* Added "LevelFilteredPrinter.setNoErrors()".
:* Added "evaluateExpressionTo(@Nullable String[] imports, String input,Class<T> targetType, Mapping<String, ?> variables)".
:* Added convenience methods with a parameter "Object... variableNamesAndValues" for all methods with a parameter "Mapping<String, ?> variables".
:* Added "or(PredicateWhichThrows<? super T, ? extends EX> lhs, PredicateWhichThrows<? super T, ? extends EX> rhs)" as a brother of "or(Predicate<? super T> lhs, Predicate<? super T> rhs)".
:* Added "containsKeyPredicateWhichThrows(final Mapping<K, V>)".
:* Removed the "<EX>" type parameter from "ExpressionEvaluator.parser(String spec)".
:* Optimized "toPredicate()" and "constantExpression()" for the special cases "true", "false" and "null".
:* Replaced "HttpAuthenticationServlett(String realm, String userName, String password)" with "HttpAuthenticationServlett(String realm, UserNamePasswordPredicate)".
:* Added "removeParameter()".
:* Added test cases for "de.unkrig.commons.util.Enums".
:* Optimized performance of "Enums.valueOf(String, Class<? extends Enum>)".
:* Added "enumSetFromString(String, Class<? extends Enum>)" and "valueOf(String, Class<? extends Enum>)".
:* Started implementation of "IndexOf.indexOf(CharSequence haystack, int minIndex, int maxIndex, int limit)" for partial terminal matches.
:* Added method "toCharArray(CharSequence cs)".
:* Added "of(T... values)", "union(Set<? extends T> lhs, Set<? extends T> rhs)" and "intersection(Set<? extends T> lhs, Set<? extends T> rhs)".
:* Added "toCharArray(Set<Character>)" and "toIntArray(Set<Integer>)".
:* Added "append(char[] a, char... values)" and "mirror(char[][])".
:* Fixed up several bugs in "boyerMooreHorspool...()".
:* Renamed methods "knuthMorrisPratt...()" to "boyerMooreHolbrook...()".
:* Fixed up the Knuth-Morris-Pratt "lastIndexOf()" method.
:* More optimization on the "knuthMorrisPratt()" index-of algorithm.
:* Renamed the "...Index" parameters of the "IndexOf.(indexOf|lastIndexOf)()" methods from "(from|to)Index" to "(min|max)Index", because "from" and "to" are very confusing for "lastIndexOf()".
:* Utility functionality related to {@link HttpsURLConnection}s.
:* Added "ExpressionEvaluator.parsePart()".
:* Added "ExpressionEvaluator.parsePart()".
:* "getMostSpecificMethod()": Didn't find some methods declared in superinterfaces.
:* Added "containsKeyPredicate(Mapping)".
:* The non-"...WhichThrows" protocol classes now declare the EX type parameter as "NoException" (was "RuntimeException") to make any code more self-documenting.
:* "isLessSpecific()": The synthetic methods that are generated for covariant return values were regarded as "ambiguous".
:* The "transformer" argument is now allowed to throw IOExceptions.
:* "copyAndTransform()" now declares an "EX" type parameter.
:* Added the "assertFind()" methods.
:* Added "StringUtil.asJavaLiteral(String)".
:* Added "IterableUtil.addAllElementsTo(Iterable, Collection)" and "IteratorUtil.addAllElementsTo(Iterator, Collection)".
:* Moved "EMPTY_SORTED_SET" and "emptySortedSet()" from "CollectionUtil" to "Sets", leaving (deprecated) wrappers behind.

; Version 1.2.11 2017-08-23:
:* Added methods "Rule.goTo(S)", "Rule.push(S)" and "Rule.pop()", making many of the "StatefulScanner.addRule(...)" methods DEPRECATED.
:* Added utility class "OptionalMethods".
:* Made JRE 7's methods "isAlphabetic(int)" and "isIdeographic(int)" available for all JRE versions.
:* "Token.captured" is no longer @Nullable; this is much more practical.
:* Added "PrettyPrinter.codePointToString(int)".
:* Added the following methods, and the plethora of predicates that implement them:
:** javaCharacterClassFromName(String)
:** unicodeCategoryFromName(String)
:** unicodeBinaryPropertyFromName(String)
:** unicodePredefinedCharacterClassFromName(String)
:** posixCharacterClassFromName(String)
:* Improved the "unexpected character" exception message by adding information about the current scanner state.
:* Added the "de.unkrig.commons.util.EnhancedServiceLoader".
:* Added appropriate "toString()" methods on "IndexOf" implementations.
:* Extended the "StringUtil.IndexOf" interface with various "lastIndexOf()" methods.
:* Added "StringUtil.newIndexOf(final String infix)" which implements the Knuth-Morris-Pratt algorithm.

; Version 1.2.10 2017-07-30:
:* Added method "MD5.of(InputStream)".
:* Added utility class "de.unkrig.commons.lang.Comparators".
:* CompressUtil: The "UnsupportedZipFeatureException" was not properly wrapped because it has none of the "usual" constructors that "ExceptionUtil.wrap()" requires.
:* Added "InputStreams.readAll(InputStream, boolean closeInputStream)".
:* de.unkrig.commons.util.collections.Peekerators: Introduced the concept of the "peekerator" - an Iterator with a "peek()" method.
:* IterableUtil: Added "IterableUtil.NATURALS" and "NATURALS0".
:* de.unkrig.commons.util.collections: Added methods "IteratorUtil.foR(...)" and "IterableUtil.foR(...)".
:* de.unkrig.commons.util.collections: Moved "iteratorWithContext()" from IterableUtil to IteratorUtil.
:* de.unkrig.commons.util.collections: Made "ElementWithContext" a top-level type, because it is now used by two compilation units (IteratorUtil and IterableUtil).
:* commons-net and commons-util: Moved the "CustomAuthenticator" (and its fellows "CredentialsSpec", "JPasswordFields" and "Regex" from the ANTOLOGY project to the "de.unkrig.commons.net" project, where it belongs.
:* CommandLineOptions: Gave "printResource(Class, String relativeResourceName, ...)" a sibling method "printResource(ClassLoader, String resourceName, ...)".
:* de.unkrig.commons.net.http.HttpMessage: In "attempt unstreaming" mode, the body was written TWICE (caused IllegalStateExceptions).
:* de.unkrig.commons.net.http: Added support for the "CONNECT" method.
:* Added to many methods parameter(s) "xxxLoggingPrefix" so that one can customize the logging messages. By default, logging messages related to incoming data are prefixed with ">>> ", and logging messages related to outgoing data with "<<< ".
:* HttpMessage: The "attempt unstreaming" feature can now be switched off (important for the CONNECT method).
:* "IoUtil.copy()" now flushes the output stream when the next READ from the input stream will block.
:* de.unkrig.commons.text.expression: Added support for nested types.
:* Changed the return types of "Expression.evaluateTo[Primitive](...)" from "Object" to "T".
:* AuthenticateHeaderParser: Implemented BASIC authentication for the "HttpClient" - useful to configure HTTP proxies that handle authentication.
:* unkrig.commons/text/scanner: Added "String[] Token.captured" for access to input subsequences that were captured during the token match.
:* ConsumerUtil: Added methods "head(m)" and "tail(n)".
:* "Transformer" now extends "TransformerWhichThrows<I, O, RuntimeException>", as it always should have done.
:* Added "BooleanProducer ProducerUtil.once()".
:* Added the "de.unkrig.commons.text.scanner.XmlScanner" class and tests.
:* Added "StringUtil.containsAny(String subject, String characters)", which checks whether the subject contains any of the characters.
:* Added the "FilterAppendable", very much in anaolgy with the "java.io.FilterWriter".
:* Added "CharSequences.from(char[])" and "CharSequences.from(char[], int off, int len)".
:* Added the "Appendables" utility class.
:* de.unkrig.commons.doclet.html.Html: Added support for {@value} on enum constants.
:* de.unkrig.commons.doclet.html.Html: STANDARD_LINK_MAKER: Added support for links to enum constants.
:* de.unkrig.commons.text.expression.ExpressionEvaluator: Breaking API change: "evaluateTo(..)" now returns a _nullable_ result.
:* ConsumerUtil: Added various "store()" and "cumulate()" methods.
:* de.unkrig.commons.net.http.HttpMessage: Added method "body(final ProducerWhichThrows<InputStream, IOException> in)".
:* Automatic XML formatting is now not only active for content type "text/xml", but for any content type with an infix "xml".
:* de.unkrig.commons.io.ReaderInputStream: First implementation of the "ReaderInputStream" as the complement of the "WriterOutputStream"; as of now supports only char set ISO8859-1.
:* TransformingFilterReader: Bug fixed: "TransformingFilterReader.read()" returned -1 on the first pattern match.
:* de.unkrig.commons.doclet.html.Html: @value: The argument was not SGML-Escaped.
:* TransformerUtil: Added "cache(final Transformer<? super I, O> delegate, final Map<I, O> cache)".
:* ContentsProcessings.processArchive(): "Directory archive entries" are now silently ignored, because they have no contents and thus it makes no sense to process them with the "contentsProcessor".
:* FileUtil: Added a workaround for MS WINDOWS 7: Read-protected directory produces: isDirectory() => true; canRead() => true; list() => null; listFiles() => null (Caused NPEs.)
:* PasswordAuthenticationStores: "..customAuthenticator_credentials,orig" file was not deleted after saving the credentials properties file.

; Version 1.2.9 2017-02-02:
:* de.unkrig.commons.crypto/security: Gave up on the concept of "DestroyableString"s - they cause more confusion than they are helpful.
:* ProducerUtil: Fixed a serious bug in "cacheAsynchronously()": ExecutionExceptions thrown by the Future were not handled properly and caused the cache to "hang".
:* Added "roundRobin()".

; Version 1.2.8 2017-01-27:
:* New utility class "AssertString": Provides methods like "assertContains(String expectedInfix, String actual)".
:* Added a new package "de.unkrig.commons.lang.crypto", and moved many classes from "lang.security" to there.
:* Extracted the UserNamePasswordStore from "de.unkrig.antology.task.SetAuthenticatorTask" to here.
:* Added "StatefulScanner.getCurrentState()" and "setCurrentState()" so that the state of the scanner can be changed from outside admidst scanning.
:* Added "AbstractScanner.suppress(TT)" and "suppress(EnumSet<TT>)".
:* Added "ProducterUtil.filter(Producer, Predicate)".
:* StatefulScanner: Declared a constant "REMAIN" for the "addRule()" methods that have a final "nextState" parameter.
:* AbstractParser: End-of-input handling was brooken in "read(Object... tokenTypeOrText)".
:* Added the "de.unkrig.commons.lang.Characters" utility class.
:* The first parameter of methods "StatefulScanner.addRule(EnumSet<S>, ...)" is now NULLABLE, where "null" means "any state, including the default state".
:* Added a constructor "StatefulScanner(StatefulScanner)" that clones the configuration, but not the state.
:* StatefulScanner: Added methods "addRule(@Nullable EnumSet<S> states, String regex, TT tokenType)" and "addRule(@Nullable EnumSet<S> states, String regex, TT tokenType, S nextState)", which make it easier to declare rules that apply in more than one non-default states.
:* Fixed one major design error in "CommandLineOptions": Method "applyCommandLineOption()" now gets a "Method" as its second parameter, instead of, previously, a "CommandLineOption" object.

; Version 1.2.7 2016-12-12:
:* IoUtil: Added "singlingFilterReader()" and "singlingInputStream()".
:* PatternUtil: Fixed several bugs in "PatternUtil.replaceAll()".
:* PatternUtil: Added "replaceAllFilterReader()".
:* PatternUtil: Added "replaceAllFilterWriter()".
:* Moved many, many methods from "IoUtil" to the new utility classes "InputStreams", "OutputStreams", "Readers", "Writers" and "FransformingFilter(Reader|Writer)".
:* Added "StringTransformers", a collection of simple "Transformer<CharSequence, CharSequence>"s.
:* Added TransformerUtil.chain(Transformer...)".
:* Extracted "PatternUtil.replaceAllFilterReader()" as the new "Substitutor" class.
:* Adapted to the refactoring of "IoUtil".
:* Added unit tests for the "Substitutor".
:* "IoUtil.findOnPath()": The search stopped at the FIRST archive file.

; Version 1.2.6 2016-11-30:
:* commons-io: Added the "CharFilter", "CharFilterReader" and "CharFilterWrite", which are the char-wise equivalent of "ByteFilter(InputStream|OutputStream)?".
:* Glob: Added the "" special case for the "container match".
:* FileProcessings, ContentsProcessings: The "pathPredicate" was missing from content processors.

; Version 1.2.5 2016-11-28:
:* Printers: Added "Printers.redirectToFile(Level|EnumSet<Level>)".

; Version 1.2.4 2016-11-25:
:* IoUtil: Fixed one MalformedURLException.
:* Added the "ByteFilterOutputStream", as a complement to the "ByteFilterInputStream".
:* ContentsTransformations: Added methods "chain(ContentsTransformer, ContentsTransformer)", "asInputStream(InputStream delegate, ContentsTransformer, String)" and "asOutputStream(ContentsTransformer, OutputStream delegate, name)".
:* Added "SelectiveContentsTransformer.create()", which can conduct many optimizations.
:* Workover of the "Printers" API: A lot of functionality went from "Printers" to "AbstractPrinter"; the old methods, however, remain, and are now marked as @deprecated.
:* IoUtil: Added methods "findOnPath(File[], String resourceName)" and "copyTree(URL, File)".
:* Added "de.unkrig.commons.lang.ClassLoaders".
:* Slightly clarified the wording of the license: Replaced "author" with "copyright holder and its contributors".

; Version 1.2.3, 2016-11-07:
:* commons-file: The "formats" files didn't make it into the JAR, because they were in "src/main/java" instead of "src/main/resource".

; Version 1.2.2, 2016-11-07:
:* XmlUtil.parse(): Detect and throw IOExceptions (esp. FileNotFoundException) properly.
:* commons-junit4: Removed the unnecessary dependency on "org.apache.commons:commons-compress".
:* For unknown reasons, the POM of org.apache.commons:commons-compress fails to declare the dependency on "org.tukaani:xz", although it definitely depends on it. Thus added the dependency in "de.unkrig.commons:commons-file"'s POM.
:* "IoUtil.parallel()", as a side effect, caused the JVM to not terminate when it is shut down orderly (i.e. "main()" returns or "System.exit()" is invoked).
:* Added "ThreadUtil.DAEMON_THREAD_FACTORY".

; Version 1.2.1, 2016-10-30:
:* Removed the nasty circular dependencies around "commons-junit".

; Version 1.2.0, 2016-10-24:
:* Replaced the old ANT build with MAVEN.

; Version 1.1.12, 2016-10-14:
:* Bug fixes in "ProducerUtil.cache()".

; Version 1.1.11, 2016-08-13:
:* ProducerUtil.cache...(): The "invalidationCondition" was treated the wrong way around in some places. Pulled things straigt.
:* PredicateUtil: Added method "static synchronizedPredicate(Predicate)".

; Version 1.1.10, 2016-08-12:
:* ProducerUtil.cache(): When the first call of "delegate.produce()" threw an exception, then the NEXT invocation returned NULL (instead of calling "delegate.produce()" again).
:* ProducerUtil: Added "cacheAsynchronously()" and "atMostEvery(ms, firstProduct, startAtTrueProduct)".

; Version 1.1.9, 2016-08-02:
:* Fixed the bounds of of the parameters of some "MapUtil()" methods, to make them more versatile.

; Version 1.1.8, 2016-07-26:
:* Moved various map-related methods from "CollectionUtil" to "MapUtil" (where they actually belong), marked the original methods with "@Deprecated" and replaced them with invocations of the "new" methods.
:* Moved a few more fields and methods from "CollectionUtil" to "IterableUtil" and "IteratorUtil", where they belong.
:* Added many missing bounds to method parameters to make the methods more flexible.

; Version 1.1.7, 2016-06-17:
:* Added "ObjectUtil.hashCode()".
:* Added "PredicateUtil.always(boolean)".
:* Added "PredicateUtil.xor()".
:* "Predicate<T>" now extends "PredicateWhichThrows<T, RuntimeException>".
:* Added "ProducerUtil.cache(delegate, condition)".
:* "commons/doclet": Added support for the inline tags "{@docRoot}", "{@literal}", "{@constantsof}" and "{@constantsofplain}".
:* CommandLineOptions: Initial support for "option cardinality" and "option group cardinality".
:* Added "de.unkrig.commons.util.Enums".
:* Added the "IdentityHashSet".
:* Added methods "Pipe.read(byte[])" and "Pipe.write(byte[])".
:* Changed type parameter "EX" of "(Consumer|Function|Predicate|Producer|Runnable|Transformer)WhichThrows" interfaces from "extends Exception" to "extends Throwable" to allow for seamless handlich of the "Longjump" throwable.
:* Added a static "ignoreExceptions()" method to the "(Consumer|Function|Predicate|Producer|Runnable|Transformer)Util" classes.
:* Longjump: Added various "catchLongjump()" methods for easy integration with Java 8 lambdas.
:* Added the following methods:
:** IoUtil.copy(File, File, CollisionStrategy)
:** IoUtil.copyTree(File, File, CollisionStrategy)
:** IoUtil.isContentIdentical(File, File)

; Version 1.1.6, 2016-03-21:
:* Added "ObjectUtil.almostNull()".

; Version 1.1.5, 2016-03-14:
:* de.unkrig.commons.io.IoUtil: Added "skip()" and "skipAll()".
:* de.unkrig.commons.text.PatternUtil: Replaced the "Replacer" interface with a "Function<Matcher, String>".
:* de.unkrig.commons.file.ExceptionHandler: Handler methods now have, for consistency with the other APIs, an additional parameter "String path".
:* de.unkrig.commons.net: TcpServer(SSLContext): Remove several "cipher suites" from the SSL context because otherwise some modern browsers refuse to connect with this server.

; Version 1.1.4, 2015-11-11:
:* de.unkrig.commons.text: JavaScanner/JsonScanner: The CXX_COMMENT now INCLUDES the trailing line break.
:* de.unkrig.commons.net: Added Utility class "UrlConnections", with the single method "followRedirects2()".
:* de.unkrig.commons.text: Replaced "CamelCase" with the more versatile "Notations" helper class.
:* de.unkrig.util.collections: Added the "Stack" interface and its implementation "ArrayStack".
:* de.unkrig.commons.lang: Added the "FunctionWhichThrows" interface and the "Functions" utility class.

; Version 1.1.3, 2015-09-19:
:* de.unkrig.commons.doclet: Removed the concept of generating MEDIAWIKI markup - MEDIAWIKI is for COLLABORATION, not for documentation.
:* Added "de.unkrig.commons.util.CommandLineOptions" for elegant command line processing.
:* Added "de.unkrig.commons.util.concurrent.ByteStreamSequentializer" and "ObjectSequentializer".

; Version 1.1.2, 2015-08-31:
:* Added optional dependencies on 'xz' and APACHE COMPRESS.
:* Added "de.unkrig.commons.doclet".
:* Added "de.unkrig.commons.text.xml".
:* Added "de.unkrig.commons.util.collections.IteratorUtil".
:* Various bug fixes in de.unkrig.commons.file
:* Added "de.unkrig.commons.file.contentstransformation.TextTransformer".
:* "de.unkrig.commons.file.fileprocessing" now supports parallel execution.
:* The "JavaScanner" now decodes unicode escapes - strictly speaking: wrong, but very useful in some situations.

; Version 1.1.1, 2015-02-24:
:* Gave up on Java 5 compatibility; Java >= 6 is now required.
:* UPDATE no longer takes two separate paramaters 'glob' and 'update-file', but one parameter 'glob=update-file', which makes it possible to use variable references when creating the 'update-file' name.
:* Push releases to OSSRH and eventually to MAVEN CENTRAL

; Version 1.1.0, 2015-02-04:
:* Major refactoring of 'de.unkrig.commons.file.fileprocessing' and 'de.unkrig.commons.file.contentsprocessing'.
:* de.unkrig.commons.file.filetransformation: Thanks to apache.commons.compress, we now not only support the ZIP archive format and the GZIP compression algorithm, but also the AR, ARJ, CPIO, DUMP, JAR, TAR and SEVEN_Z archive formats and the BZIP2, PACK200, XZ, LZMA, SNAPPY and Z compression algorithms.
:* Added 'de.unkrig.commons.lang.security.Sandbox'.

; Version 1.0.5, 2014-05-01:
:* Moved the <log>, <logging> and <simpleLogging> tasks from 'de.unkrig.commons.util' to 'de.unkrig.antcontrib'.

; Version 1.0.4, 2014-04-29:
:* 'keepOriginals' did not work for in-place file transformations.
:* <simplelogging>: Added attribute 'spec="..."'.
:* <simpleLogging>: Attribute 'debug="..."' no longer is boolean, but "FINE|FINER|FINEST".
:* <logging>: Removed attribute 'parent="..."'
:* <logging>: Added attribute 'clearFilter="true"'.
:* Renamed task <simplelogging> to <simpleLogging> (with a big 'L').

; Versions 1.0.3 and earlier:
: No change log available.

Unkrig.de

2024-05-02T15:39:18Z

Aunkrig: /* Retired Projects */

 
<div align="center"><font size="+6"><b>Welcome to unkrig.de!</b></font><br><br><font color="#777">''Where the fine software grows''</font></div>
 

[[image:Javawordcloud.png|right]]

== Preamble ==

Hello out there!

I am a professional programmer, and when I have time I work on several cool open source projects. Find them useful, interesting, inspiring - or contribute! To contact me, send email to 'arno att unkrig dott de'.

Cheers, Arno

== Larger Projects ==

=== [https://janino-compiler.github.io/janino/ Janino] ===
: A super-small, super-fast Java™ compiler for embedded applications where you want to compile code on-the-fly into byte code which is executed in the running JVM.

=== [https://github.com/aunkrig/lfr LFR - Lightning-fast Regular Expressions for Java] ===
: A 99.9%-complete reimplementation of <code>java.util.regex</code> ("JUR") with better <code>match()</code> and <code>find()</code> performance.

=== [[Zz.unkrig.de|ZZ Tools]] ===
: Enhanced versions of the widely known DIFF, FIND, GREP and PATCH command-line tools, which handle not only directories and files, but also archive and compressed files, and even nested archive and compressed files. They can even disassemble Java <code>.class</code> files on-the fly and operate on the disassembly.

=== [[Cs-contrib.unkrig.de|CheckStyle Contributions]] ===
: Additional checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS].

=== [[Commons.unkrig.de]] ===
: A versatile Java™ library, including a highly flexible HTTP and FTP server.

== Smaller Projects ==

=== [https://github.com/aunkrig/autoauth AUTOAUTH] ===

An HTTP proxy that handles proxy authentication.

=== [[Doclet|Doclets]] ===

Doclets are a way to re-use the JAVADOC tool to do other things than just generate Java API documentation. I wrote a few of them for different purposes:

===== [[ANT doclet|The ANT Doclet]] =====
: Generates JAVADOC-like HTML documentation for an ANTLIB, e.g. for [[Antology]] and the [[Zz.unkrig.de|ZZ tools]].

===== [[Cs-doclet|The CheckStyle Doclet]] =====
: Generates the metadata files for CheckStyle and eclipse-cs from 'doc tags' in the source code of your checks and filters.

===== [[JAVADOC doclet|The JAVADOC Doclet]] =====
: A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "[[No-template|no-template]]" framework.

===== [[MAIN doclet|The MAIN Doclet]] =====
: Generates HTML documentation for a "main()" method - useful for command line tools with a set of command line options.

=== [[Html2txt|html2txt]] ===
: A Java tool to convert HTML documents into plain text.

=== [[JDisasm|jdisasm]] ===
: A disassembler for Java .class files.

=== [[No-template|no-template]] ===
: A super-small Java library for templating, i.e. generating text files (HTML, XML, whatever) from a "template" text file.

== Retired Projects ==

These projects are no longer maintained and are only of limited use, e.g. because they work only with old Java versions.

=== [[Antology]] ===
: Some contributions to [http://ant.apache.org APACHE ANT], e.g. the <code><swingDialog></code> task which significantly enhances ANT's <code><input></code> task.

=== [[Loggifier.unkrig.de|Loggifier]] ===
: A tool for automatic injection of logging code into Java™ class files, making it unnecessary to mess up your code with hand-written logging.

=== [[Cvstools.unkrig.de|Eclipse plug-in for extended CVS possibilities]] ===

: An ECLIPSE plug-in that adds CVS functionality that is sometimes painfully missing from ECLIPSE's built-in CVS client.

=== [[Subclipse.unkrig.de|Subclipse enhancements Eclipse plug-in]] ===

: The often-missed <code><de.unkrig.subclipse.svn></code> ANT task that uses the SUBCLIPSE client of the running ECLIPSE workbench.

Unkrig.de

2024-05-02T15:38:59Z

Aunkrig: /* Larger Projects */

 
<div align="center"><font size="+6"><b>Welcome to unkrig.de!</b></font><br><br><font color="#777">''Where the fine software grows''</font></div>
 

[[image:Javawordcloud.png|right]]

== Preamble ==

Hello out there!

I am a professional programmer, and when I have time I work on several cool open source projects. Find them useful, interesting, inspiring - or contribute! To contact me, send email to 'arno att unkrig dott de'.

Cheers, Arno

== Larger Projects ==

=== [https://janino-compiler.github.io/janino/ Janino] ===
: A super-small, super-fast Java™ compiler for embedded applications where you want to compile code on-the-fly into byte code which is executed in the running JVM.

=== [https://github.com/aunkrig/lfr LFR - Lightning-fast Regular Expressions for Java] ===
: A 99.9%-complete reimplementation of <code>java.util.regex</code> ("JUR") with better <code>match()</code> and <code>find()</code> performance.

=== [[Zz.unkrig.de|ZZ Tools]] ===
: Enhanced versions of the widely known DIFF, FIND, GREP and PATCH command-line tools, which handle not only directories and files, but also archive and compressed files, and even nested archive and compressed files. They can even disassemble Java <code>.class</code> files on-the fly and operate on the disassembly.

=== [[Cs-contrib.unkrig.de|CheckStyle Contributions]] ===
: Additional checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS].

=== [[Commons.unkrig.de]] ===
: A versatile Java™ library, including a highly flexible HTTP and FTP server.

== Smaller Projects ==

=== [https://github.com/aunkrig/autoauth AUTOAUTH] ===

An HTTP proxy that handles proxy authentication.

=== [[Doclet|Doclets]] ===

Doclets are a way to re-use the JAVADOC tool to do other things than just generate Java API documentation. I wrote a few of them for different purposes:

===== [[ANT doclet|The ANT Doclet]] =====
: Generates JAVADOC-like HTML documentation for an ANTLIB, e.g. for [[Antology]] and the [[Zz.unkrig.de|ZZ tools]].

===== [[Cs-doclet|The CheckStyle Doclet]] =====
: Generates the metadata files for CheckStyle and eclipse-cs from 'doc tags' in the source code of your checks and filters.

===== [[JAVADOC doclet|The JAVADOC Doclet]] =====
: A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "[[No-template|no-template]]" framework.

===== [[MAIN doclet|The MAIN Doclet]] =====
: Generates HTML documentation for a "main()" method - useful for command line tools with a set of command line options.

=== [[Html2txt|html2txt]] ===
: A Java tool to convert HTML documents into plain text.

=== [[JDisasm|jdisasm]] ===
: A disassembler for Java .class files.

=== [[No-template|no-template]] ===
: A super-small Java library for templating, i.e. generating text files (HTML, XML, whatever) from a "template" text file.

== Retired Projects ==

These projects are no longer maintained and are only of limited use, e.g. because they work only with old Java versions.

=== [[Loggifier.unkrig.de|Loggifier]] ===
: A tool for automatic injection of logging code into Java™ class files, making it unnecessary to mess up your code with hand-written logging.

=== [[Cvstools.unkrig.de|Eclipse plug-in for extended CVS possibilities]] ===

: An ECLIPSE plug-in that adds CVS functionality that is sometimes painfully missing from ECLIPSE's built-in CVS client.

=== [[Subclipse.unkrig.de|Subclipse enhancements Eclipse plug-in]] ===

: The often-missed <code><de.unkrig.subclipse.svn></code> ANT task that uses the SUBCLIPSE client of the running ECLIPSE workbench.

Zz.unkrig.de

2024-05-02T15:23:49Z

Aunkrig:

A set of command-line tools that handle not only directories and files, but also archive and compressed files, and even nested archive files. They can even disassemble Java <code>.class</code> files on-the fly and operate on the disassembly.

== Tool Documentation ==

=== zzdiff ===

Computes the differences between files, directory trees, archive file entries, compressed files and prints them in various formats; widely compatible with the UNIX™ DIFF command line utility.

Read the [http://zz.unkrig.de/maindoc/zz-diff/Main.main(String%5b%5d).html command line tool documentation].

Read the [http://zz.unkrig.de/antdoc/index.html?tasks/zzdiff.html ANT task documentation].

=== zzfind ===

Finds files in directory trees and entries in archive files by various criteria; widely compatible with the UNIX™ FIND command line utility.

Read the [http://zz.unkrig.de/maindoc/zz-find/Main.main(String%5b%5d).html command line tool documentation] (or the [http://zz.unkrig.de/maindoc/zz-find/Main.main(String%5b%5d).txt plain text version]).

Read the [http://zz.unkrig.de/antdoc/index.html?tasks/zzfind.html ANT task documentation].

=== zzgrep ===

Finds lines in files in directory trees and in entries in archive files by regular expressions; widely compatible with the UNIX™ GREP command line utility.

Read the [http://zz.unkrig.de/maindoc/zz-grep/Main.main(String%5b%5d).html command line tool documentation].

Read the [http://zz.unkrig.de/antdoc/index.html?tasks/zzgrep.html ANT task documentation].

=== zzpack ===

Creates an archive file from a set of given files, directories, and archive entries.

Read the [http://zz.unkrig.de/maindoc/zz-pack/Main.main(String%5b%5d).html command line tool documentation].

Read the [http://zz.unkrig.de/antdoc/index.html?tasks/zzpack.html ANT task documentation].

=== zzpatch ===

Modifies the contents of files in directory trees and of entries in archive files by various criteria; widely compatible with the UNIX™ PATCH command line utility.

Read the [http://zz.unkrig.de/maindoc/zz-patch/Main.main(String%5b%5d).html command line tool documentation].

Read the [http://zz.unkrig.de/antdoc/index.html?tasks/zzpatch.html ANT task documentation].

== Download and Installation ==

=== Runnable JAR files ===

<html>
<form method="get" action="https://repository.sonatype.org/service/local/artifact/maven/redirect">
<input type="hidden" name="r" value="central-proxy" />
<input type="hidden" name="g" value="de.unkrig.zz" />
<input type="hidden" name="v" value="LATEST" />
<input type="hidden" name="c" value="jar-with-dependencies" />

Latest version of
<select name="a">
<option>zz-diff</option>
<option>zz-find</option>
<option>zz-grep</option>
<option>zz-pack</option>
<option>zz-patch</option>
</select>
<input type="submit" value="DOWNLOAD" />
</form>
</html>

=== MS WINDOWS executables ===

<html>
<form method="get" action="https://repository.sonatype.org/service/local/artifact/maven/redirect">
<input type="hidden" name="r" value="central-proxy" />
<input type="hidden" name="g" value="de.unkrig.zz" />
<input type="hidden" name="v" value="LATEST" />
<input type="hidden" name="p" value="exe" />

Latest version of
<select name="a">
<option>zz-diff</option>
<option>zz-find</option>
<option>zz-grep</option>
<option>zz-pack</option>
<option>zz-patch</option>
</select>
<input type="submit" value="DOWNLOAD" />
</form>
</html>

Notice: These executables require an installed JRE; at least version 1.6. They will complain if they cannot find a suitable JRE, and give advice how to get things running.

=== APACHE ANT libraries ===

<html>
<form method="get" action="https://repository.sonatype.org/service/local/artifact/maven/redirect">
<input type="hidden" name="r" value="central-proxy" />
<input type="hidden" name="g" value="de.unkrig.zz" />
<input type="hidden" name="v" value="LATEST" />
<input type="hidden" name="c" value="jar-with-dependencies" />

Latest version of
<select name="a">
<option value="zz-all">All-in-one</option>
<option>zz-diff</option>
<option>zz-find</option>
<option>zz-grep</option>
<option>zz-pack</option>
<option>zz-patch</option>
</select>
<input type="submit" value="DOWNLOAD" />
</form>
</html>

To use the ANT types, insert one of the following lines in your build script:

<taskdef resource="de/unkrig/zz/zz-diff.xml" classpath="path/to/zz-diff-x.y.z-jar-with-dependencies.jar" />
<taskdef resource="de/unkrig/zz/zz-find.xml" classpath="path/to/zz-find-x.y.z-jar-with-dependencies.jar" />
<taskdef resource="de/unkrig/zz/zz-grep.xml" classpath="path/to/zz-grep-x.y.z-jar-with-dependencies.jar" />
<taskdef resource="de/unkrig/zz/zz-pack.xml" classpath="path/to/zz-pack-x.y.z-jar-with-dependencies.jar" />
<taskdef resource="de/unkrig/zz/zz-patch.xml" classpath="path/to/zz-patch-x.y.z-jar-with-dependencies.jar" />

If you use more than one of the tools in your build script, it is more efficient to use the "all-in-one" JAR file:

<taskdef resource="de/unkrig/zz/zz-all.xml" classpath="path/to/zz-all-x.y.z-jar-with-dependencies.jar" />

=== Java Library ===

The ZZ tools also have a public Java API that can be used from by any Java application. You can either download and use this JAR file, or, if you're using MAVEN, put in your "pom.xml" file:

<dependency>
<groupId>de.unkrig.zz</groupId>
<artifactId>zz-diff</artifactId> 
<version>x.y.z</version>
</dependency>

Here is the API documentation:

* [http://zz.unkrig.de/javadoc/zz-diff/ zz-diff API documentation]
* [http://zz.unkrig.de/javadoc/zz-find/ zz-find API documentation]
* [http://zz.unkrig.de/javadoc/zz-grep/ zz-grep API documentation]
* [http://zz.unkrig.de/javadoc/zz-pack/ zz-pack API documentation]
* [http://zz.unkrig.de/javadoc/zz-patch/ zz-patch API documentation]

== Resources ==

<html>
<form method="get" action="https://repository.sonatype.org/service/local/artifact/maven/redirect">
<input type="hidden" name="r" value="central-proxy" />
<input type="hidden" name="g" value="de.unkrig.zz" />
<input type="hidden" name="v" value="LATEST" />
<input type="hidden" name="c" value="sources" />

Source code is available on <a href="https://github.com/aunkrig/zz">GITHUB</a>,
and also through MAVEN:
<select name="a">
<option>zz-diff</option>
<option>zz-find</option>
<option>zz-grep</option>
<option>zz-pack</option>
<option>zz-patch</option>
</select>
<input type="submit" value="DOWNLOAD" />
</form>
</html>

The ZZ tools make heavy use of [http://commons.unkrig.de/ commons.unkrig.de].

== License ==

ZZ.UNKRIG.DE is published under the "[[New BSD License]]".

== Change Log ==

; Changes in version 1.3.11-SNAPSHOT (not yet released):
:* -

; Changes in version 1.3.10, 2022-12-29:
:* Changed handling of "-" to ResourceProcessings.STDIN_URL.
:* ZZDIFF can now handle "-" (stdin) as one of its two inputs.
:* ZZPATCH: --substitute: Removed the concept of the "replacement mode", because the extended replacement syntax just implements the "literal" and "expression" replacement modes.
:* ZZPACK: Added the "--rename" feature.
:* ZZPATCH: Substitution: Replacement mode "REPLACEMENT_STRING" now supports "ext syntax", i.e. "${...}" embedded expressions.
:* ZZPATCH: ExitException message is now "Printers.info()"ed instead of "Printers.verbose()"ed.
:* ZZFIND: Greatly simplified the computation of the expression variables.
:* ZZFIND: Fixed an exception when finding in STDIN: STDIN does not have the properties "readable", "writable" and "executable".
:* ZZFIND: Class file version can now be accessed by "cf.javaVersion".
:* ZZFIND: MAINDOC: Documented the "archiveEntry" variable.
:* ZZGREP: Moved "Grep.lineCounter()" to "ConsumerUtil".
:* ZZGREP: Eliminated the 65536-characters-per-line limit -- finds and counts matches now also in very long lines.
:* ZZPATCH: Added the "--assert-count" condition for updates/substitution replacements/patch hunks/removals/renamings/additions.
:* ZZFIND: Learned that the various ZIP archive libraries return random values for "ZipEntry.getMethod()" and "ZipEntry.getCrc()", thus made the test cases tolerant against these.
:* ZZFIND: Don't print a stack trace on predicate parse errors; only print the error message.
:* ZZPATCH: Added command line options for archive decryption: --7z-input-file-password --zip-input-file-password --password
:* ZZPATCH: Added command line options for archive compression and encryption: --zip-output-entry-compression-level --zip-output-file-password --zip-output-file-encryption-method
:* ZZFIND: Added short command line option for archive decryption: --password
:* ZZFIND: Added the "-version" command line option.
:* ZZGREP: Added command line options "--input-encoding" and "--output-encoding". (Previously, the output encoding was not configurable.)
:* ZZGREP: Fixed the printing of "--" separator lines between context-grep chunks.
:* ZZFIND: MAINDOC: Documented priority of operators.
:* ZZFIND: CatAction: Entries that have no input stream (e.g. directories or directory archive entries) are silently ignored, because that is practical: Otherwise, you'd always have to put "-type normal*" right before the "-cat" action.
:* ZZFIND: -copy action: Now ignore entries that have no input stream (e.g. directories or directory archive entries), because that is practical: Otherwise, you'd always have to put "-type normal*" right before the "-copy" action.
:* ZZFIND: -copy action: Attempt to restore each file's "last modification date", too.
:* ZZPATCH: Unified DIFF format: Some DIFF tools (namely GNU diffutils 3.5) put a TAB character (instead of a SPACE) between the file name and the date.
:* ZZFIND: Added "--toFile" option to "-disassemble".
:* ZZFIND: Added new variable "archiveEntry".
:* ZZFIND: Added action "-java-class-file".
:* ZZFIND: Added expression variable "compressionMethod" (for archive entries).

; Changes in version 1.3.9, 2020-11-06:
:* Updated jdisasm to 1.0.6.
:* Updated de.unkrig.commons to 1.2.15.
:* Removed the generation of the "...-antlib.jar" file, because "...-jar-with-dependencies.jar" can be used as an ANTLIB as well.
:* Fixed the file type in the output of -ls.
:* Added expression variables "readable", "writable" and "executable".
:* Adapted to an incompatible API change in "commons-file" (all content processing was augmented with an optional "lastModifiedDate" parameter).
:* Fixed an NPE that occurred with 7Z archive entries that have NO modification date set.
:* ZZFIND now compiles with JDK 1.8 (before it was 1.6).
:* Major refactoring: Replaced "Mappings properties" with "Map<String, Function<Object, Object>> properties.
:* Implemented the new expression variables "_map", "_keys" and "_values".
:* Context diff: The "hunk separator line" ("--") was missing.
:* Actions that read the contents of a document (-cat, -copy, -disassemble, -digest, -checksum) didn't for "normal-file" documents.
:* "--nowarn", "--quiet", "--verbose" and "--debug" now not only configure the "Printers", but also "SimpleLogging".
:* Added the "--replacementMode" option which allows for more complex replacements than the java.util.regex.Matcher can offer

; Changes in version 1.3.8, 2019-10-09:
:* zzgrep: Implemented "-e".
:* zzgrep: Implemented "--byte-offset", "--with-path", "--no-path", "--label", "--line-number", "--after-context", "--before-context" and "--context".
:* <zzpatch> Ant task: "<substitution><regex>..." and "...<replacement>...": Property "replacement" was missing for "addText()".
:* Major refactoring of "zz.Find" - removed tons of copied code.
:* zzfind: Improved handling of corrupt archives and compressed contents.

; Changes in version 1.3.7, 2019-08-05:
:* In addition to "...-jar-with-dependencies.jar", generate a "...-antlib.jar" file, where the ANT classes are NOT included.
:* The "-copy" action now supports a "--append" (alias "-a") modifier.
:* Now using "ExpressionEvaluator.parseExt()".
:* Added "--printf" command line action.
:* Fixed the "line equivalence" and the "ignore" feature; both were accidentially broken with revision 6980 (affects only release 1.3.5).
:* The "zz-diff" command line tool now also accepts URLs on its command line.
:* "--verbose" had no effect; now it prints the names of files and archive entries that are searched.

; Changes in Version 1.3.6, 2018-07-24:
:* Added a test case for "zzpatch --substitute --iff".
:* Substitution conditions now support a new variable, "occurrence".
:* Added a "<condition>" subelement on the "<substitution>" element. This is useful, e.g., to replace only the FIRST match.
:* For conformance with GREP, exit with status 2 (not 1) on errors.
:* <zzfind>: Added the "<prune />" and "<delete />" subelements.
:* zzfind: Renamed option "--depth" to "--descendants-first" (and left the original as an alias).
:* <zzfind>: Renamed the depth="..." attribute to descendantsFirst="...".
:* Added the "-prune" and "-delete" actions.
:* Added "&&" and "-and" as aliases for "-a".
:* Added "||" and "-or" as aliases for "-o".
:* Added options "da-verbose", "da-source-directory" and "da-symbolic-labels".
:* Continue with next archive entry on IOException.
:* ZZGREP: When run with a list file-or-dirs, only every second file-or-dir was searched.

; Changes in version 1.3.4, 2017-02-03:
:* Added a workaround for: MS WINDOWS 7: Read-protected directory produces: isDirectory() => true canRead() => true list() => null listFiles() => null (Caused NPEs.)
:* ZZDIFF: Bug fixed: Document DIFF was always UNIFIED, regardless of the document diff mode setting.
:* Change version of de.unkrig.commons from "1.2.6-SNAPSHOT" to "1.2.7-SNAPSHOT" (because THAT is the correct post-1.2.6 version).
:* Renamed "namePredicate" to "pathPredicate".
:* Replaced the "name=..." attribute with "path=...", and marked the old attribute as @deprecated.
:* The "pathPredicate" was missing from content processors.
:* Generate ANTDOC only for the "zz-all" module, not for "zz-(diff|find|grep|pack|patch)" individually. Saves on build time, and reduces redundant documentation.

; Changes in version 1.3.3, 2016-11-28:
:* Removed unnecessary dependency on "jdisasm".

:* Fixed the classpath for zz-all antdoc.
:* Added the "--no-recurse-subdirctories" command line option.
:* Extracted the "DOcumentDiff" class from the "Diff" class.
:* Added task attribute "recurseSubdirectories=false".
:* Added the "Diff.diff(path1, path2, stream1, stream2)" method.

; Changes in version 1.3.2, 2016-11-25:
:* Added test cases for ZZDIFF.
:* Added "Diff.execute(String path1, String path2, ...)" to allow for custom "path1" and "path2" strings when reporting differences.
:* Improved many "DiffException"s' messages.
:* Slightly clarified the wording of the license: Replaced "author" with "copyright holder and its contributors".
:* Include project name and version in APIDOC's "-header" and "-footer".

; Changes in version 1.3.1, 2016-11-07:
:* The JVM (sometimes) did not terminate when it is shut down orderly (i.e. "main()" returns or "System.exit()" is invoked).
:* Added the "launch4j" maven plugin that creates MS WINDOWS executables from the runnable JAR files.
:* Made the scope of the "ant" dependency "provided", so that the classes of "ant.jar" don't get into the "jar-with-dependencies".
:* Added JAVADOC "overview.html" files for the five zz tools.
:* ZZFIND: Made many methods and nested types PUBLIC, so they can be used via the Java API.
:* Moved ANTDOC generation from "zz-parent/build.ant" to "zz-parent/pom.xml".
:* Added "zz-all", which is an aggregation of the five ZZ tools.

; Changes in version 1.3.0, 2016-10-30:
:* ZZFIND, <zzfind>: Line separator was missing from the "LS" action.
:* ZZFIND, <zzfind>: Added the "-digest" and "-checksum" actions.
:* ZZFIND: Allow combinations of file names and "-" (STDIN).
:* <zzfind>: Added "<true/>" and "<false/>".
:* ZZFIND: Added "-true" and "-false".
:* <zzfind>: The expression subelements are now named ANT components.
:* ZZFIND: Variable substitution (in "-echo" and "-copy") now supports "@variableName" in addition to "@{variable-name}".
:* ZZDIFF, <zzdiff>: Added options "addedFile" and "deletedFile" which supersede "newFile" and "unidirectionalNewFile".
:* <zzpatch>: File/entry renaming did not work (flag Glob.REPLACEMENT was missing).
:* <zzfind>: Renamed the "<path>" expression component to "<path_>" to avoid a name clash with the global type with the same name.
:* Switched from the old ANT build to MAVEN.

; Changes in version 1.2.5, 2016-02-12:
:* ZZFIND, <zzfind>: Added the "depth" property.
:* ZZFIND, <zzfind>: Added the "comma operator", "-mtime", "-depth", "-minDepth" and "-maxDepth".

; Changes in version 1.2.4, 2016-02-10:
:* <zzpatch>: "condition=..." is now an attribute of the <patch> subelement, not the task.
:* zzdiff: Added command line option "--normal".
:* All pathes: Compressed file names and compressed contents paths are now suffixed with '%' (instead of '!') to circumvent problems with "Glob"'s directory prefix mechanism.
:* ZZFIND on STDIN threw exceptions, because "-ls" requires "isDirectory", "size", etc.
:* ZZFIND: Parsing of special command line argument "-" (for "STDIN") didn't work.
:* ZZGREP: The "-quiet" command line option did not have any effect.

; Changes in version 1.2.3, 2015-09-27:
:* ZZFIND command line tool: Option "--look-into": Glob was compiled WITHOUT the WILDCARD|INCLUDES_EXCLUDES flag.

; Changes in version 1.2.2, 2015-09-27:
:* ZZPATCH ant task: Removed attribute "memberName=..." from subelement "<add>", because the ant task does not traverse directories (opposed to the command line version), and thus adding members to directories is not possible.
:* ZZDIFF: Fixed some NPEs that occurred when files / entries are EXCLUDED.
:* ZZFIND: Added the "DisassembleAction" (disassembles a Java .class file).
:* Generate and publish HTML documentation for ANT tasks with ANTDOC.

; Changes in version 1.2.1, 2015-05-24:
:* FIND: Command line tool and ANT task now continue with next directory member on IOExceptions.
:* DIFF: Added the "tokenization" configuration parameter, which allows for Java token-based DIFFing.
:* DIFF: Added the "ignoreCStyleComments" and "ignoreCPlusPlusStyleComments" configuration option (relevant iff "tokenization" is "JAVA").
:* The classes for the 'zzpack' ant task were missing from the jar file.
:* ZZFIND ant task: Added the "file=..." and "dir=..." attributes.
:* ZZFIND: Added the "<echo message=...>" and "<property name=... value=...>" actions.

; Changes in version 1.2.0, 2015-04-30:
:* "ArchiveFormatFactory" and "CompressionFormatFactory" now register "URLStreamHandler"s for all archive and compression formats, so these can be used as "protocols" of "java.net.URL", e.g. "zip:file:foo.zip!file.txt".
:* Major refactoring of 'de.unkrig.commons.file.fileprocessing' and 'de.unkrig.commons.file.contentsprocessing'. Effectively, ZZGREP can now use these classes, because 'process()' now returns 'T'.
:* Renamed the following classes for consistency with 'java.util.Collections', '...Arrays', etc.:
:** ContentsProcessingUtil => ContentsProcessings
:** ContentsTransformerUtil => ContentsTransformations
:** FileProcessingUtil => FileProcessings
:** FileTransformationUtil => FileTransformations
:* ANT integration: Added the '<patch>' filter (for use in ANT 'filter chain's).
:* ANT integration: Added the 'condition' property to the '<zzpatch>' task.
:* ZZDIFF: Added the "-sequential" command line option.
:* <zzdiff>: Replaced the 'lookInto[Nested](Zip|Gzip)="..."' attributes with the (more flexible) 'lookInto="..."' attribute.
:* <zzdiff>: Replaced the "<exclude>" subelements with the "path=..." attribute, eliminating the unusual "negative" logic.

; Changes in version 1.1.0, 2014-10-25:
:* zzpatch: No file arguments mean 'transform STDIN to STDOUT'.
:* zzpatch: Added 'conditions' for the 'substitute', 'replace', 'patch', 'remove', 'rename' and 'add' features.
:* zzpatch: Added 'dontSortDirectoryMembers' feature.
:* de.unkrig.commons.file: Thanks to apache.commons.compress, we now not only support the ZIP archive format and the GZIP compression algorithm, but also the AR, ARJ, CPIO, DUMP, JAR, TAR and SEVEN_Z archive formats and the BZIP2, PACK200, XZ, LZMA, SNAPPY and Z compression algorithms.
:* <zzpatch>, <zzgrep>: Removed the 'dir="..."' and 'sortDirectoryMembers="..."' attributes from these ANT tasks because recursing directories is ANT's job.
:* <zzpatch>, <zzgrep>: Replaced the 'lookInto[Nested](Zip|Gzip)="..."' attributes with the (more flexible) 'lookInto="..."' attribute.
:* <zzgrep>: Removed the "dir=..." attribute.

; Changes in version 1.0.11, 2014-04-12:
:* ZZDIFF: Added option '-unchanged-files' resp. ANT task attribute 'reportUnchangedFiles="true"': Also report unchanged files.
:* ZZDIFF: Added '-zip' and '-nested-zip' command line options - aliases for '-z' and '-zz'.
:* ZZFIND: Added the '-copy' action - similar to '-cat', but copies the data bytewise.
:* <zzfind>: Added a '<sequential>' subelement.
:* <zzgrep>: Added attributes 'file="..."' and 'dir="..."'
:* <zzpatch>: Added attributes 'file="..."', 'tofile="..."', 'dir="..."' and 'todir="..."'
:* de.unkrig.commons.util: <simplelogging>: Added attribute 'spec="..."'.
:* <zzgrep>: Added attribute 'property="..."'.
:* <zzgrep>: Added subelement '<search name="..." regex="..." caseSensitive="..."/>'
:* <zzgrep>: Made the 'case sensitivity logic' POSITIVE.
:* <zzgrep>: Removed the '<include>' and '<exclude>' subelements in favor of 'name="..."'.
:* <zzgrep>: 'name="..."', 'regex="..."' and 'caseSensitive="..."' are now mutually exclusive with '<search>' subelements.
:* <zzgrep>: Runtime optimization: Now only the files to which at least one search applies are processed.

; Changes in version 1.0.10, 2014-03-22:
:* ZZDIFF: Added option '-keep-going' resp. ANT task attribute 'keepGoing="true"': Report errors and continue with next file.

; Changes in version 1.0.9, 2014-03-20:
:* COMMONS.UTIL: Added the SIMPLELOGGING task that was missing from 'antlib.xml'.
:* COMMONS.FILE: Inserted lots of logging.
:* ZZPATCH: Added the <regex> and <replacement> subelements to <substitute>: Alternative to the 'regex=...' and 'replacement=...' attributes. The major advantage of the subelements is that they can contain '<![CDATA[...]]>' sections where you don't have to SGML-escape special characters.
:* ZZPATCH: Added lots of logging to make ANT build file debugging easier.
:* ZZPATCH: Contents substitution is no longer line-wise, but allows for multi-line matching and replacement.
:* ZZFIND: Now searching STDIN iff no file specified.
:* ZZDIFF: Added diff mode 'EXIST', which is like diff mode 'QUIET' but ignores CONTENT differences.

; Changes in version 1.0.8, 2013-11-29:
:* ZZDIFF: Absent file modes COMPARE_*_WITH_EMPTY: Added and deleted directories were counted as difference, although they shouldn't.

; Changes in version 1.0.7, 2013-11-26:
:* The ZZ tools now live in ONE jar file; there is a new 'Main' class that forks into the various tools
:* Renamed the tasks from 'de.unkrig.zz.diff' to 'zzdiff'.
:* ZZDIFF: Absent file modes COMPARE_ADDED_AND_DELETED_WITH_EMPTY and COMPARE_ADDED_WITH_EMPTY: Added and deleted DIRECTORIES are now treated as EMPTY directories.
:* ZZDIFF: Added ANT task property 'property'.

; Changes in version 1.0.6, 2013-10-02:
:* ZZPATCH: '-patch' now preserves line separators (instead of silently replacing them with the default line separator).

; Changes in version 1.0.5, 2013-10-01:
:* ZZDIFF: Added the 'encoding' attribute to the ant task.
:* ZZFIND: Added the missing '<cat>' and '<ls>' actions to the ant task.
:* ZZFIND: Added the '-encoding' option to the command line tool.
:* ZZGREP: Added the 'encoding' attribute to the ant task.
:* ZZGREP: Added the '-encoding' option to the command line tool.
:* ZZPATCH: Added 'inputEncoding' and 'outputEncoding' to 'substitution' and 'patch'.
:* ZZPATCH: Added 'patchFileEncoding' to 'patch'.
:* ZZPATCH: '-substitute' now preserves line separators (instead of silently replacing them with the default line separator).

; Changes in version 1.0.4, 2013-09-22:
:* ZZFIND: The 'readable', 'writable', 'size' and 'modificationTime' tests were missing from the ANT task

; Changes in version 1.0.3, 2013-09-22:
:* ZZDIFF: Added the 'absentFileMode' option (a.k.a. as '-new-file' and '-unidirectional-new-file').
:* SimpleLogging: VERBOSE messages were not printed because the OUT_HANDLER was misconfigured.

; Changes in version 1.0.2, 2013-07-05:
:* Fixed a major bug: 'SelectiveContentsTransfomer' executed BOTH delegates when the predicate evaluates to FALSE. This didn't hurt in many cases, but for 'zzpatch -update' it did.

; Changes in version 1.0.1, 2013-06-14:
:* Major refactoring of 'de.unkrig.commons'.

; Version 1.0.0, 2012-10-03:
Initial release.

Subclipse.unkrig.de

2024-05-01T19:22:42Z

Aunkrig: Created page with "== Introduction == This ECLIPSE plug-in adds an additional ANT task 'de.unkrig.subclipse.svn' which is available in ANT builds which have the option 'Run in the same JRE as the workspace' set. The ANT task uses the SVN client that is provided by the SUBCLIPSE plug-in. Thus no configuration is required, because it is re-used from SUBCLIPSE. == Download and Installation == Within ECLIPSE, download and install the feature from the update site http://subclipse.unkrig.d..."

== Introduction ==

This ECLIPSE plug-in adds an additional ANT task 'de.unkrig.subclipse.svn' which is available in ANT builds which have the option 'Run in the same JRE as the workspace' set.

The ANT task uses the SVN client that is provided by the SUBCLIPSE plug-in. Thus no configuration is required, because it is re-used from SUBCLIPSE.

== Download and Installation ==

Within ECLIPSE, download and install the feature from the update site

http://subclipse.unkrig.de/update

The change log is available [http://subclipse.unkrig.de/changelog.txt here].

== Task Documentation ==

: [http://subclipse.unkrig.de/antdoc/tasks/de.unkrig.subclipse.svn.html <code><de.unkrig.subclipse.svn></code>]

== Examples ==

Tagging projects in SVN:


<fail
unless="eclipse.running"
message="Please activate the ECLIPSE external tool configuration option 'Run in the same JRE as the workspace' and re-run."
/>


<fail message="Please install the 'de.unkrig.subclipse' ECLIPSE feature and re-run.">
<condition><not><typefound name="de.unkrig.subclipse.svn" /></not></condition>
</fail>

<property name="d" value="http://svn.acme.com/svn/MyRepo/tags/${tag}"/>
<de.unkrig.subclipse.svn>
<mkdir url="${d}"/>
<copy srcpath="." desturl="${d}"/>
<copy srcpath="../project2" desturl="${d}"/>
</de.unkrig.subclipse.svn>

If you like loading ANT tasks in separate XML namespaces, you can alternatively write:

<''some-enclosing-tag-e-g-project-or-target'' <font color="red">xmlns:unkrig="antlib:de.unkrig.subclipse"</font>>
...

<fail
unless="eclipse.running"
message="Please activate the ECLIPSE external tool configuration option 'Run in the same JRE as the workspace' and re-run."
/>


<fail message="Please install the 'de.unkrig.subclipse' ECLIPSE feature and re-run.">
<condition><not><typefound <font color="red">uri="antlib:de.unkrig.subclipse" name="svn"</font> /></not></condition>
</fail>

<<font color="red">unkrig:svn</font>>...

, where "<code>unkrig</code>" is the (arbitrary) XML namespace prefix.

== License ==

SUBCLIPSE.UNKRIG.DE is published under the "[[New BSD License]]".

== Source Code ==

Source code is available via SVN on

:https://svn.code.sf.net/p/loggifier/code

. From that repository, check out the projects
*de.unkrig.checkstyle-configuration
*de.unkrig.commons.nullanalysis
*de.unkrig.subclipse_dist
*de.unkrig.subclipse.ant.tasks
*de.unkrig.subclipse.branding
*de.unkrig.subclipse.core
*org.apache.ant-1.8.4
, or, if you are using ECLIPSE, just import https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.subclipse_dist/projectSet.psf.

== Contact ==

For bugs, improvements, complaints, or any other kind of feedback, send email to [mailto:arno@subclipse.unkrig.de arno@subclipse.unkrig.de].

File:Ant Task.jpg

2024-05-01T19:18:36Z

Aunkrig:

File:Custom CVS Command Dialog.jpg

2024-05-01T19:18:04Z

Aunkrig:

File:CVS Tools Menu Remote.jpg

2024-05-01T19:16:25Z

Aunkrig:

File:CVS Tools Menu.jpg

2024-05-01T19:14:57Z

Aunkrig:

Cvstools.unkrig.de

2024-05-01T19:14:07Z

Aunkrig: Created page with "<big>'''CVS Tools - an ECLIPSE plug-in for advanced CVS operations'''</big> == Overview == A nice little ECLIPSE plug-in that adds CVS functionality that is sometimes painfully missing from ECLIPSE's built-in CVS client. == Custom CVS command user interface == * A "CVS Tools..." entry in the popup menus of all resources that are under CVS control. 400x400px * A "CVS Tools..." entry in the popup menu of all remote resources in the "CVS Repo..."

<big>'''CVS Tools - an ECLIPSE plug-in for advanced CVS operations'''</big>

== Overview ==

A nice little ECLIPSE plug-in that adds CVS functionality that is sometimes painfully missing from ECLIPSE's built-in CVS client.

== Custom CVS command user interface ==
* A "CVS Tools..." entry in the popup menus of all resources that are under CVS control.
[[Image:CVS_Tools_Menu.jpg|400x400px]]
* A "CVS Tools..." entry in the popup menu of all remote resources in the "CVS Repositories" view.
[[Image:CVS_Tools_Menu_Remote.jpg|400x400px]]
* These open the "Custom CVS Command" dialog in which you can configure and run any CVS command.
[[Image:Custom_CVS_Command_Dialog.jpg|400x400px]]

== The "eclipse.cvs" and "eclipse.rcvs" ANT tasks ==
These ANT tasks provide access to the CVS client that is part of the ECLIPSE platform. Using that is much cooler than running an external "cvs.exe" (as the normal "cvs" ANT task does).

[[Image:Ant_Task.jpg|400x400px]]

=== '''eclipse.cvs''' ===

==== '''Attributes''' ====
'''quiet'''
:No messages in the CVS console.
'''debug'''
:Unexpected exception print stack traces in the CVS console.
'''command'''
:One of add, admin, annotate, commit, diff, edit, editors, history, log, ls, release, remove, status, tag, unedit, update, version, watch-add, watch-off, watch-on, watch-remove, watchers.
'''argument'''
:Only for the "tag" command.

==== '''Subelements''' ====
<'''globaloption''' option="-n"/>
:One of -Q, -q, -r, -n, -t, -l (For descriptions see the "Custom CVS Commands" dialog or "cvs --help-options").

<'''localoption''' option="-r1.5"/><br/>
<'''localoption''' option="-m" argument="My Message"/>
:Command-dependent; for descriptions see the "Custom CVS Commands" dialog or "cvs -H ''command''".
<'''fileset'''>...<br/>
<'''dirset'''>...
:See ANT documentation.

=== '''eclipse.rcvs''' ===

==== '''Attributes''' ====
'''cvsroot'''
:Format:
::* :method:[user[:password]@]hostname[#port]:/path/to/repository (CVSNT)
::* :method:[[user][:password]@]hostname[:[port]]/path/to/repository (other)
'''quiet'''
:No messages in the CVS console.
'''debug'''
:Unexpected exception print stack traces in the CVS console.
'''command'''
:One of checkout, export, import, rannotate, rlog, rdiff, rls, rtag, version.
'''argument'''
:Only for the "rtag" command.

==== '''Subelements''' ====
<'''globaloption''' option="-n"/>
:One of -Q, -q, -r, -n, -t, -l (For descriptions see the "Custom CVS Commands" dialog or "cvs --help-options").

<'''localoption''' option="-r1.5"/><br/>
<'''localoption''' option="-m" argument="My Message"/>
:Command-dependent; for descriptions see the "Custom CVS Commands" dialog or "cvs -H ''command''".
<'''module''' name="foo"/>...
:Target CVS module.

== Download and Installation ==
Download the plug-in JAR file from

:http://cvstools.unkrig.de/download/

and copy it into your ECLIPSE's "dropins" subdirectory, then "File / Restart" your ECLIPSE.

Source code is available via SVN on

:https://svn.code.sf.net/p/cvstools/code

== Project status ==
Everything is still very experimental, and not all CVS commands, options and combinations thereof have been tested. Still I feel that there may be some interest out there for these tools? Use, comment, contribute!

== License ==

CVSTOOLS is published under the "[[New BSD License]]".

Loggifier.unkrig.de / Tools / Java agent

2024-05-01T19:12:49Z

Aunkrig: Created page with "Probably the most convenient way to loggify classes at runtime is to start the JVM with the following command line option: $ java -javaagent:path/to/de.unkrig.loggifier.jar ... The LOGGIFIER plugs into the [http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/package-summary.html "Java programming language agents" API] (available since Java 5) and implements loggification at class-loading time. The agent interprets its argument as (newline-separated) loggif..."

Probably the most convenient way to loggify classes at runtime is to start the JVM with the following command line option:

$ java -javaagent:path/to/de.unkrig.loggifier.jar ...

The LOGGIFIER plugs into the [http://docs.oracle.com/javase/7/docs/api/java/lang/instrument/package-summary.html "Java programming language agents" API] (available since Java 5) and implements loggification at class-loading time.

The agent interprets its argument as (newline-separated) loggification rules:

$ java '-javaagent:path/to/de.unkrig.loggifier.jar<span style="color:blue">=CLINIT=INFO
> ALL=FINER</span>' ...

Loggifier.unkrig.de / Tools / LoggifyingClassLoader

2024-05-01T19:12:09Z

Aunkrig: Created page with "From inside a running JVM, you can load loggified classes with the help of the <code>de.unkrig.loggifier.LoggifyingClassLoader</code>."

From inside a running JVM, you can load loggified classes with the help of the <code>de.unkrig.loggifier.LoggifyingClassLoader</code>.

Loggifier.unkrig.de / Tools / Ant task

2024-05-01T19:11:19Z

Aunkrig: Created page with "LOGGIFIER defines a new task "<de.unkrig.loggifier>" that loggifies your code just like the command line tool. See the example to see how to make the new task accessible from inside your ANT script. == Attributes == ;selector=''glob'' :Which class files to instrument, e.g. "~**Test*.class". Default is "all files". ;out=''file'' :Where to write the output file or directory. Default is to perform an "in-place" loggification. ;keepOrig..."

LOGGIFIER defines a new task "<de.unkrig.loggifier>" that loggifies your code just like the command line tool. See the [[#Example|example]] to see how to make the new task accessible from inside your ANT script.

== Attributes ==

;selector=''glob'' :Which class files to instrument, e.g. "~**Test*.class". Default is "all files".
;out=''file'' :Where to write the output file or directory. Default is to perform an "in-place" loggification.
;keepOriginals=''boolean'' :Keep copies of the original files (e.g. <code>.MyClass.class.orig</code> and <code>.MyJar.jar.orig</code>).

== Subelements ==

;<rule>''text''</rule> :A loggification rule, e.g. 'STORE=FINE'
;Resource Collection (<fileset> etc.) :The files to loggify (.class, .jar, .war, .ear, ...)

== Example ==

<project>
<taskdef classpath="lib/de.unkrig.loggifier.jar" resource="de/unkrig/loggifier/ant.properties" />

<target name="default">
<de.unkrig.loggifier>
<rule>ALL=FINE</rule>
<fileset file="bin/Main.class" />
</de.unkrig.loggifier>
</target>
</project>

File:Loggifer project properties page.png

2024-05-01T19:09:11Z

Aunkrig:

Loggifier.unkrig.de / Tools / Eclipse plug-in

2024-05-01T19:08:28Z

Aunkrig: Created page with "When the plug-in is installed (see below), you will find a new page in the 'Project Properties' dialog: File:Loggifer_project_properties_page.png Here you can enable and configure loggification for the project."

When the plug-in is installed (see below), you will find a new page in the 'Project Properties' dialog:

[[File:Loggifer_project_properties_page.png]]

Here you can enable and configure loggification for the project.

Loggifier.unkrig.de / Tools / Command line tool

2024-05-01T19:07:46Z

Aunkrig: Created page with "Running the LOGGIFIER command line tool with the '<code>-help</code>' option explains its usage: Implants logging code into Java class files, and also into class files in directory trees, ZIP format files (.zip, .jar, .war, .ear, ...) and nested ZIP format files (e.g. .war in .ear). Usage: java de.unkrig.loggifier.Main [ <option> ] ... <file-or-dir> Transforms the given <file-or-dir> in-place. java de.unkrig.loggifier.Main [ <option> ] ......"

Running the LOGGIFIER command line tool with the '<code>-help</code>' option explains its usage:

Implants logging code into Java class files, and also into class files in
directory trees, ZIP format files (.zip, .jar, .war, .ear, ...) and nested ZIP
format files (e.g. .war in .ear).

Usage:
java de.unkrig.loggifier.Main [ <option> ] ... <file-or-dir>
Transforms the given <file-or-dir> in-place.
java de.unkrig.loggifier.Main [ <option> ] ... <file-or-dir> ... <dir>
Transforms the given <file-or-dir>s into files-and-dirs with the same names in <dir>.
java de.unkrig.loggifier.Main [ <option> ] ... <file-or-dir> <file-or-new-dir>
Transforms the given <file-or-dir> into <file-or-new-dir>.

Valid options:
-help Shows this text.
-keep Keep copies of original files (iff transforming in-place).
-selector <glob>
Loggify only classes matching the <glob>.
-logging-system <id>
Style of the logging code to inject.
<id> is 'jre14', 'log4j', 'log4j2' or 'slf4j'. The default is
to guess, based on the classes on the classpath.
-rule <rule> Add the given loggification rule (format see below).
-nowarn -quiet -verbose -debug
-log <level>:<logger>:<handler>:<formatter>:<format>
Configure the log output of this command line tool.

The loggification rule format is as follows:
<action>[,<action>]...=<level>[:<expression>]

<action>: One of [ALOAD, ARITH, ASTORE, CAST, CATCH, CLINIT, CONST,
CONVERT, ENTRY, GET, INVOKE, INSTANCEOF, LENGTH,
LOAD, NEW, PUT, RESULT, RETURN, STORE, SWITCH, THROW].
<level>: One of [OFF SEVERE WARNING INFO CONFIG FINE FINER FINEST].
<expression>: E.g. '(<eq> || <eq>) && !<eq>', where
<eq>: '<var> == <glob>', where
<var>: is one of [action source classAccess class methodAccess method
line type classAndField variable].
For actions [CAST INSTANCEOF NEW] also 'type'.
For actions [GET PUT] also 'classAndField'.
For actions [LOAD STORE] also 'name'.
<glob>: is a 'glob pattern' in single quotes like '*main*'.

The exit status is 1 iff errors occurred during loggification.

Loggifier.unkrig.de

2024-05-01T19:06:54Z

Aunkrig: Created page with "== Motivation == Have you ever wondered how much cleaner your code would look if it weren't littered with all that logging code? And, when you're hunting bugs in production environments, do you produce tons of logging output, but often find that the critical bit of information that you need is missing? If the answers are "no" and "no", then stop reading. Otherwise, LOGGIFIER may be the tool you need. == Overview == The concept of LOGGIFIER is as follows: * Relevant..."

== Motivation ==

Have you ever wondered how much cleaner your code would look if it weren't littered with all that logging code? And, when you're hunting bugs in production environments, do you produce tons of logging output, but often find that the critical bit of information that you need is missing?

If the answers are "no" and "no", then stop reading. Otherwise, LOGGIFIER may be the tool you need.

== Overview ==

The concept of LOGGIFIER is as follows:

* Relevant class files are instrumented during the build process:<br />Code similar to
<nowiki>if (MyClass.__logger123.isLoggable(Level.FINE)) {
Helper.logp(
MyClass.__logger123, // logger
Level.FINE, // level
"com.acme.MyClass", // sourceClass
"main(String[])", // sourceMethod
"MyClass.java", // source
120, // lineNumber
"ENTRY args=(args={0})", // message
new Object[] { arg1 } // parameters
);
}</nowiki>
: is inserted all over the place. (<code>Helper.logp()</code> eventually calls <code>java.util.logging.Logger.logp()</code>, after having done some pretty-printing on the message arguments.) Where exactly (in the example: At the top of 'MyClass.main()'), and at what log level (here: FINE) is controlled by the applicable [[#Loggification rules|loggification rules]]. In typical scenarios, the default rules should generate a reasonable amount of logging points.
* The instrumentation remains even in production. This is possible because the instrumentation is optimized for very low overhead (as you can see in the code above: The call to 'isLoggable()' is typically super fast).
* Alternatively you loggify the code only when you start debugging. This is often less practical, because it requires that you either have access to the .jar/.war/.ear files in the target environment., or restart the JVM with loggification activated. Also, the restart or the loggification may influence the problems that you want to track down.
* Then, when it comes to debugging, you enable logging at runtime, e.g. by editing the 'logging.properties' file, or by connecting to the running JVM through JMX. LOGGIFIER does not have one single Logger or one Logger per class, but separate loggers for all classes, methods and events. (Loggers are cheap, so the cost for having hundreds of them is low.) Hence you can enable the logging very selectively and thereby keep the amount of logging output reasonable.

== Getting started ==

Click [[Loggifier.unkrig.de / Getting Started|here]] to take the fast track to Loggifier.

== Tools ==

There are various tools to loggify your classes:

* At build time:
** The LOGGIFIER [[Loggifier.unkrig.de / Tools / Command line tool|command line tool]]
** The LOGGIFIER [[Loggifier.unkrig.de / Tools / Eclipse plug-in|ECLIPSE plug-in]]
** The <code><de.unkrig.loggifier></code> [[Loggifier.unkrig.de / Tools / Ant task|ANT task]]
* At runtime:
** The [[Loggifier.unkrig.de / Tools / LoggifyingClassLoader|LoggifyingClassLoader]]
** The LOGGIFIER [[Loggifier.unkrig.de / Tools / Java agent|Java agent]]

== Loggification ==

The LOGGIFIER loads a class file and analyzes the bytecode of the class's constructors and methods. Looking at the code, it identifies "interesting" points where logging code could be inserted. Each of the logging points is characterized by an [[#Logging actions|action]]. For each logging point, the relevant [[#Loggification rules|loggification rules]] are executed, and the first that matches determines at what level the logging event is to be logged (or if no logging code is injected for this logging point). Loggification rules optionally have a [[#Discriminator expression|discriminator expression]], which has a set of [[#Discriminator expression parameters|parameters]].

=== Logging actions ===

Each section of code is characterized by an 'Action'. For example, the JVM bytecodes <code>PUTFIELD</code> and <code>PUTSTATIC</code> are characterized by action '''PUT'''.

{| class="wikitable"
|-
|'''ALOAD''' ||Log array type, array value, index and element value read from an array
|-
|'''ARITH''' ||Log operands, operator (+, -, ...) and result of an arithmetic operation
|-
|'''ASTORE''' ||Log the array, the index and the value being stored in an array
|-
|'''CAST''' ||Log the type to which the operand is casted
|-
|'''CATCH''' ||Log the declared catch type and the actually caught exception
|-
|'''CLINIT''' ||Log the name of a class that is initialized
|-
|'''CONST''' ||Log the value of a constant being pushed on the operand stack
|-
|'''CONVERT''' ||Log a value that is arithmetically converted and the conversion result
|-
|'''ENTRY''' ||Log the target object (if non-static) and the arguments as a method begins execution
|-
|'''GET''' ||Log declaring class of, name of, source instance of (if non-static) and value read from a field
|-
|'''INVOKE''' ||Log signature, target object (if non-static) and arguments right before a method is invoked
|-
|'''INSTANCEOF'''||Log the type to which the operand type is compared
|-
|'''LENGTH''' ||Log the array who's length is determined
|-
|'''LOAD''' ||Log type of, name of and value read from a local variable
|-
|'''NEW''' ||Log the type of a new object being instantiated
|-
|'''PUT''' ||Log declaring class of, name of, target instance of (if non-static) and value assigned to field
|-
|'''RESULT''' ||Log method signature and invocation result (if not 'void')
|-
|'''RETURN''' ||Log the value that is being returned by a method (if not 'void')
|-
|'''STORE''' ||Log value assigned to, type of and name of a local variable
|-
|'''SWITCH''' ||Log the integer value that a switch is being executed on
|-
|'''THROW''' ||Log an exception right before it is thrown
|}

=== Loggification rule syntax ===

A rule triggers if and only if
* It applies to the action of the loggification point (ENTRY, EXIT, THROW, ...)
* Its discriminator expression (if any) evaluates to TRUE for the actual point (who's properties are availables as variables in the discriminator expression, see above)

The syntax of all loggification rules is:

loggification-rule :=
( action { ',' action } | 'ALL' ) '=' level [ ':' discriminator-expression ]

action :=
(One of the actions documented above)

level :=
'SEVERE' | 'WARNING' | 'INFO' | 'CONFIG' | 'FINE' | 'FINER' | 'FINEST'

discriminator-expression :=
(Syntax defined below)

Examples of valid loggification rules are:

ALL=FINE
ENTRY=FINE
ARITH=FINE
LOAD,CONVERT,ARITH,STORE=FINE
ALL=FINE:class =* "de.*"

(<code>=*</code> is the 'glob matching operator', e.g. "hello" matches "he*".)

=== Loggification rule precedence ===

The sequence of checked rules for each logging point is as follows:

;If the constructor or method being instrumented has a '@Loggify' annotation (not for action CLINIT)
:Its values in reverse order (i.e. the last value/rule takes the highest precedence).

;If a field 'static final String $$loggifierRules = "xyz"' was declared before the contructor or method being instrumented
:Its value, split at '\n', in reverse order (i.e. the last fragment/rule takes the highest precedence).

;If the class or interface being instrumented has a '@Loggify' annotation
:Its values of in reverse order (i.e. the last value/rule takes the highest precedence).

;If using the four-parameter [[Loggifier.unkrig.de / Tools / LoggifyingClassLoader|LoggifyingClassLoader]] constructor
:The 'logLevelCalculator' argument.

;If using the [[Loggifier.unkrig.de / Tools / Ant task|ANT task]]
:<code><rule></code> subelements, in reverse order (i.e. the last <code><rule></code> takes the highest precedence).

;If using the [[Loggifier.unkrig.de / Tools / Command line tool|LOGGIFIER command line tool]]
:The '-rule' options, in reverse order (i.e. the last '-rule' option takes the highest precedence).

;If using the [[Loggifier.unkrig.de / Tools / Eclipse plug-in|ECLIPSE plug-in]]
:The levels on the "Loggifier" property page of each project. (This rule ALWAYS applies, hence the following rules are never executed).

;If using the [[Loggifier.unkrig.de / Tools / Java agent|Java agent]]
:Its argument string passed to the agent, split at '\n', in reverse order (i.e. the last fragment/rule takes the highest precedence).

;If the action is LOAD or STORE, and the local variable's name ends with '__'
:FINER

;If the action is GET or PUT, and the field's name ends with '__'
:FINER

;If the action is NEW, CAST or INSTANCEOF, and the target class's name ends with '__'
:FINER

;If the action is ENTRY, RETURN or THROW
:FINER

;Last resort (when none of the above rules triggered)
:OFF

Notice that non-static fields (a.k.a. 'instance variables') are initialized by the class's constructors. Static fields ('class variables') are initialized by the synthetic <code><clinit>()</code> method, which cannot be annotated in source code.

=== Discriminator expression ===

Discriminator expressions are implemented by means of <code>de.unkrig.commons.text.expression.ExpressionEvaluator</code>; find the expression syntax documented [http://commons.unkrig.de/javadoc/de/unkrig/commons/text/expression/Parser.html here].

=== Discriminator expression parameters ===

To provide fine-grained control over loggification, the properties of each loggification point are provided as parameters to the discriminator expression:

;action
:One of the [[#Logging actions|documented logging actions]]
;source
:The name of the Java source file that JAVAC stores in each <code>.class</code> file if enabled by <code>-g:source</code>.
;classAccess
:The accessibility of the class being instrumented (<code>public</code>, <code>protected</code> or <code>private</code>)
;class
:The fully qualified name of the class being instrumented, e.g. <code>pkg.MyClass</code>
;methodAccess
:The accessibility of the method being instrumented (<code>public</code>, <code>protected</code> or <code>private</code>)
;method
:The enhanced, dequalified name of the method being instrumented, e.g. <code>meth(String, MyClass)</code> or <code><T extends IOException>meth(T, MyClass, List<T>)</code>
;line
:The line number related to the code point being instrumented that JAVAC stores in each .class file if enabled by <code>-g:lines</code>
;type
:The relevant type for the operation, e.g. <code>pkg.Class</code>, <code>pkg.Class[][]</code>, <code>int[][]</code> (only for actions '''CAST''', '''INSTANCEOF''' and '''NEW''')
;classAndField
:The subject class and field, e.g. <code>pkg.Class.field</code> (only for actions '''GET''' and '''PUT''')
;variable
:The name of the subject local variable (only for actions '''LOAD''' and '''STORE''')

At each loggification point, the LOGGIFIER determines if logging code is to be inserted or not ('discrimination') and
on which level the event will be logged at runtime ('level'). This is achieved by checking the 'loggification
rules'.

== Download ==

To get the LOGGIFIER ECLIPSE plugins, define an update site

http://loggifier.unkrig.de/update/

in "Help / Install new software...".

To get the JAR files mentioned above, download them from

http://loggifier.unkrig.de/download/

The source code is available through SVN:

https://svn.code.sf.net/p/loggifier/code

== License ==

LOGGIFIER is published under the "[[New BSD License]]".

No-template

2024-05-01T19:06:04Z

Aunkrig: Created page with "A super-small Java library for templating, i.e. generating text files (HTML, XML, whatever) from a "template" text file. The project home page is [https://github.com/aunkrig/no-template here]."

A super-small Java library for templating, i.e. generating text files (HTML, XML, whatever) from a "template" text file.

The project home page is [https://github.com/aunkrig/no-template here].

JDisasm

2024-05-01T19:05:02Z

Aunkrig: Created page with "A disassembler for Java .class files. Currently supports .class files up to and including version 8. The project home page is [https://github.com/aunkrig/jdisasm here]. == Change Log == ;Version 1.0.6 (2020-11-06): :* Changed license name from "New BSD License" to "BSD-3-Clause", because https://maven.apache.org/pom.html#Licenses recommends "... Using an SPDX identifier as the license name...". :* Changed license URL from "https://raw.githubusercontent.com/janino-com..."

A disassembler for Java .class files.

Currently supports .class files up to and including version 8.

The project home page is [https://github.com/aunkrig/jdisasm here].

== Change Log ==

;Version 1.0.6 (2020-11-06):
:* Changed license name from "New BSD License" to "BSD-3-Clause", because https://maven.apache.org/pom.html#Licenses recommends "... Using an SPDX identifier as the license name...".
:* Changed license URL from "https://raw.githubusercontent.com/janino-compiler/janino/master/LICENSE.txt" to "https://spdx.org.licenses/BSD-3-Clause.html", because the latter is probably the most reliable and stable copy. (We are already using the SPDX identifier, see above, so it appears reasonable to link to the SPDX web site.)
:* Show thrown exceptions with "MethodSignature.toString()".
:* Added Java7 and Java 11 support for LDC[_W] and LDC2_W.
:* Added support for cp_infos 17, 18, 19 and 20.

;Version 1.0.5 (2020-03-09):
:* Enable SMT generation by default... thus some regression tests currently fail.
:* Implemented the Java 9 "ModulePackages" class attribute.
:* Added command line option "printAllOffsets".
:* Implemented Java 9 "CONSTANT_Module_info" and "CONSTANT_Package_info".
:* Added command line option "printAllOffsets".
:* Fixed the disassembly of stack map frames.
:* Improved exception handling.
:* Made the new features available for the command line tool: "-show-class-pool-indexes", "-dump-constant-pool", "-print-all-attributes", "-print-stack-map".

;Version 1.0.4:
:* Implemented the "StackMapTable" attribute.
:* Fixed one NPE.
:* Signature parsing choked on signatures like "com/sun/xml/ws/server/StatefulInstanceResolver.1CookieSniffer" ("1" after ".").
:* CheckStyle clean-up with cs-contrib 1.2.19: Now not only the "{" of method declarations must be aligned, but also the "}".
:* Implemented command line option "--stack-map".
:* Issue #58: Integer overflow in ClassFile reader

;Version 1.0.3:
:* (unclear)

;Version 1.0.2:
:* Added support for the method_info's "MethodParameters" attribute.
:* "-src" now accepts a _path_ instead of a single _directory_.
:* Implemented the "StackMapTable" attribute.:* Opcodes "[adfil](load|store)_[0123]" are no longer printed as "[adfil](load|store)" (without the "implicit local variable index" suffix), but with their full mnemonic.
:* Added test cases.
:* Refactoring: Switched from a map that maps opcodes to "Instruction"s to one big SWITCH statement.
:* Java 8 fix: The operand of INVOKESPECIAL and INVOKESTATIC can now be an InterfaceMethodref, not only a Methodref.

;Version 1.0.1:
:* Remove our "own" implementation of Nullable, NotNull and NotNullByDefault, and added a dependency on"de.unkrig.commons-nullanalysis" instead.
:* MAIN class definition was missing from JAR manifest.
:* Slightly clarified the wording of the license: Replaced "author" with "copyright holder and its contributors".

;Version 1.0.0, 2016-10-30:
:(-)

MAIN doclet

2024-05-01T19:03:39Z

Aunkrig: Created page with "This doclet creates an HTML page for the <code>main(String[])</code> method (or any other method) of each of the specified classes. == Usage == <html> <h3>Doclet command line options:</h3> <dl> <dt><code>-d</code> <var>dest-dir</var></dt> <dt><code>--destination</code> <var>dest-dir</var></dt> <dd>Where to create the HTML files. <p> The effective file name is: </p> <p> <code><dest-dir>/<pkg>/<class>.<method>.html</code> </p> <p> Th..."

This doclet creates an HTML page for the <code>main(String[])</code> method (or any other method) of each of the specified classes.

== Usage ==

<html>

<h3>Doclet command line options:</h3>

<dl>
<dt><code>-d</code> <var>dest-dir</var></dt>
<dt><code>--destination</code> <var>dest-dir</var></dt>
<dd>Where to create the HTML files.
<p>
The effective file name is:
</p>
<p>
<code><dest-dir>/<pkg>/<class>.<method>.html</code>
</p>
<p>
The default destination directory is "<code>.</code>".
</p></dd>
<dt><code>--method</code> <var>method</var></dt>
<dd>The signature of the method to document. The default is "main(String[])"; for a doclet, you may want to
specify <code>"start(RootDoc)"</code>.</dd>
<dt><code>--docencoding</code> <var>charset</var></dt>
<dd>The charset to use when writing the HTML files. The default is the JVM default charset, "${file.encoding}".</dd>
<dt><code>--charset</code> <var>name</var></dt>
<dd>The HTML character set for this document.
<p>
If set, then the following tag appears in the <code><head></code> of all generated documents:
</p>
<p>
<code><meta http-equiv="Content-Type" content="text/html; charset="</code><var>charset</var><code>"></code>
</p></dd>
<dt><code>--doctitle</code> <var>title</var></dt>
<dd>The title to place near the top of the output file.</dd>
<dt><code>--quiet</code></dt>
<dd>Suppresse normal output.</dd>
<dt><code>--bottom</code> <var>text</var></dt>
<dd>For compatibility with the JAVADOC standard doclet; ignored.</dd>
<dt><code>--linkoffline</code> <var>ext-doc-url</var> <var>package-list-loc</var></dt>
<dd>For compatibility with the JAVADOC standard doclet; ignored.</dd>
<dt><code>--windowtitle</code> <var>title</var></dt>
<dd>For compatibility with the JAVADOC standard doclet; ignored.</dd>

</dl>

<h3>Supported inline tags:</h3>

<dl>
<dt><a name="main.commandLineOptions"></a><code>{@main.commandLineOptions}</code></dt>
<dt><code>{@main.commandLineOptions</code> <var>group-name</var><code>}</code></dt>
<dd>
Documentation for all command line options, generated from <code><a href="http://commons.unkrig.de/javadoc/commons-util/de/unkrig/commons/util/annotation/CommandLineOption.html">@CommandLineOption</a></code>-annotated
setter methods.<br />
If a <var>group-name</var> is given, then only those options appear which have a
<a href="#main.commandLineOptionGroup"><code>{@main.commandLineOptionGroup}</code> block tag</a> with
equal <var>group-name</var>; otherwise, only those options appear which have <em>no</em>
<code>{@main.commandLineOptionGroup}</code> block tag.
</dd>
<dt><code>{@code <var>text</var>}</code></dt>
<dt><code>{@literal <var>text</var>}</code></dt>
<dt><code>{@value <var>package</var>.<var>class</var>#<var>field</var>}</code></dt>
<dt><code>{@link <var>package</var>.<var>class</var>#<var>member</var> <var>label</var>}</code></dt>
<dt><code>{@linkplain <var>package</var>.<var>class</var>#<var>member</var> <var>label</var>}</code></dt>
<dt><code>{@docRoot}</code></dt>
<dd>
<a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags">Same as for
the standard doclet</a>.
</dd>
<dt><code>{@constantsof <var>package</var>.<var>enum-type</var>}</code></dt>
<dt><code>{@constantsofplain <var>package</var>.<var>enum-type</var>}</code></dt>
<dd>
Links to all constants of the designated enum type, separated with "<code>, </code>" (a comma and a space).
</dd>
</dl>

<h3>Supported block tags:</h3>

<dl>
<dt>
<a name="main.commandLineOptionGroup"></a><code>{@main.commandLineOptionGroup}</code> <var>group-name</var>
</dt>
<dd>
Assigns this command line option setter method to a "group"; see <a
href="#main.commandLineOptions">the <code>{@main.commandLineOptions}</code> inline tag</a>.
</dd>
</dl>
</html>

== Resources ==

Download the all-inclusive JAR file [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=doclet-main&v=LATEST&c=jar-with-dependencies here].

Find the source code [https://github.com/aunkrig/maindoc here].

== Change Log ==

; Version 1.0.5, 2018-11-23:
:* Also honor the options' "@CommandLineOption(cardinality=...)", e.g. by appending " (mandatory)" to the term of Cardinality.MANDATORY options.

; Version 1.0.4, 2018-10-18:
:* Enum @CommonsLineOption method parameter: Use "CONST1|CONST2|CONST3" as the command line argument placeholder.

; Version 1.0.2, 2016-11-25:
:* Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".
:* "html2txt" is now a dependency of the "exec-plugin", not of the project.
:* No more warnings about classes without a "main()" method.

== License ==

The MAIN doclet is available under the terms of the "new BSD license":

Copyright (c) 2015, Arno Unkrig
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of no-template nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

File:Usage.txt.jpg

2024-05-01T18:59:06Z

Aunkrig:

File:Main.main.jpg

2024-05-01T18:56:33Z

Aunkrig:

Html2txt

2024-05-01T18:55:34Z

Aunkrig: Created page with "A tool to convert HTML documents into plain text. For example this HTML code File:Main.main.jpg is rendered like this: File:usage.txt.jpg For a complete description of the supported HTML inline elements, see <span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_INLINE_ELEMENTS here]</span>. For a complete description of the supported HTML block elements, see <span class="plainlinks">[http://html2txt.unkrig.de/javad..."

A tool to convert HTML documents into plain text.

For example this HTML code

[[File:Main.main.jpg]]

is rendered like this:

[[File:usage.txt.jpg]]

For a complete description of the supported HTML inline elements, see
<span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_INLINE_ELEMENTS here]</span>.

For a complete description of the supported HTML block elements, see
<span class="plainlinks">[http://html2txt.unkrig.de/javadoc/de/unkrig/html2txt/Html2Txt.html#ALL_BLOCK_ELEMENTS here]</span>.

== Motivation ==

The goal was to generate the "usage" page that a command line tool usually prints when you invoke it with a "<tt>-help</tt>" or "<tt>--help</tt>" option, rather than maintain it manually (e.g. in the form of "<tt>println()</tt>" statements in the code).

The chosen solution is to put a big DOC comment before the "<tt>main()</tt>" method, generate an HTML page with JAVADOC, convert that into a plain text file, put it into the application's JAR file and copy its contents to STDOUT when the user want to see it.

The command line version of <tt>html2txt</tt> itself uses that technique, and you can see the results above.

== Download ==

You can download the latest version of the runnable JAR file [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=html2txt&v=LATEST&c=jar-with-dependencies here].

== Limitations ==

Since the tool uses the JRE's built-in XML parser, it supports "numeric character references" (like "&#252;" for "Ü"), but not "named HTML character entity references" (like "&Uuml;" for "Ü").

For the same reason, the HTML markup in the DOC comments must be "well-formed", i.e. all start tags must be matched by an end tag (like "<code><li>...</li></code>"), and void tags must end with a slash, like "<code><br /></code>".

== Usage ==

=== Command line tool ===

see [http://html2txt.unkrig.de/Main.main(String%5b%5d).html here].

=== ANT task ===

see [http://html2txt.unkrig.de/antdoc/index.html here].

=== Library ===

see [http://html2txt.unkrig.de/javadoc/index.html the JAVADOC].

=== Source Code ===

see [https://github.com/aunkrig/html2txt the source code repository].

== Change Log ==

; Version 1.0.2, 2016-11-25:
:* Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".

; Version 1.0.1, 2016-11-07:
:* Resurrected Java 6 compatibility.

== License ==

<code>html2txt</code> is published under the "[[New BSD License]]".

== Contact ==

If you have issues, don't hesitate to [https://sourceforge.net/p/html2txt/tickets/ submit a ticket].

To discuss in public, check the [https://sourceforge.net/p/html2txt/discussion/ forum] and/or subscribe to it (envelope icon).

JAVADOC doclet

2024-05-01T18:54:38Z

Aunkrig: Created page with "A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK. It implements many, but not all options of the original doclet. The main motivation was to demonstrate the capabilities of the no-template framework; in particular its abstract templates that render "javadocish" pages. Effectively, this doclet re-implements the JDK's standard JAVADOC doclet with only 4900 lines of code (including tons of co..."

A drop-in replacement for the standard JAVADOC doclet that is part of the JAVADOC utility which ships with the JDK. It implements many, but not all options of the original doclet.

The main motivation was to demonstrate the capabilities of the [[No-template|no-template]] framework; in particular its abstract templates that render "javadocish" pages. Effectively, this doclet re-implements the JDK's standard JAVADOC doclet with only 4900 lines of code (including tons of comments).

After all, JAVADOC is *the* reference application of a doclet, and anybody who wants to write a doclet knows it and has an idea of how to get from the JAVADOC doclet to *his* doclet.

=== Getting started ===

To use this doclet, you must run the JAVADOC utility exactly as usual, but pass <code>-doclet</code> and <tt>-docletpath</tt> command line options to replace the built-in doclet with the new one.

=== Doclet Options ===

; -d ''dest-dir''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBDAED the -d option of the original JAVADOC doclet].

; -windowtitle ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBIEEI the -windowtitle option of the original JAVADOC doclet].

; -doctitle ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJGBIE the -doctitle option of the original JAVADOC doclet].

; -header ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDAEGD the -header option of the original JAVADOC doclet].

; -footer ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDFACCA the -footer option of the original JAVADOC doclet].

; -top ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDHHGBF the -top option of the original JAVADOC doclet].

; -bottom ''text''
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDECAJE the -bottom option of the original JAVADOC doclet].

; -notimestamp
: Same as [https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDGBABE the -notimestamp option of the original JAVADOC doclet].

=== Resources ===

Find the source code [https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.doclet.javadoc here].

Ready-to-use binaries are not (yet) available.

Cs-doclet

2024-05-01T18:52:55Z

Aunkrig: Created page with "== Abstract == Cs-doclet is a [http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/ JAVADOC doclet] that generates the metadata files for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ eclipse-cs] from annotations and [http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJGIJB doc tags] in the source code of your checks and filters. This doclet is useful only for authors of CheckStyle extensions..."

File:Antdoc-ant-contrib.png

2024-05-01T18:35:28Z

Aunkrig:

ANT doclet

2024-05-01T18:33:56Z

Aunkrig: Created page with "Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs. The motivation for writing this doclet is to ease the maintenance of the documentation for the Antology antlib: 500px == Usage == <html> <h3>Doclet command line options:</h3> <dl> <dt><code>-d</code> <var>directory</var></dt> <dd>Where to create documentation in HTML format (optional). <p> The effective file name is: </p> <p>..."

Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.

The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Antology]] antlib:

[[File:antdoc-ant-contrib.png|border|500px]]

== Usage ==

<html>

<h3>Doclet command line options:</h3>

<dl>
<dt><code>-d</code> <var>directory</var></dt>
<dd>Where to create documentation in HTML format (optional).
<p>
The effective file name is:
</p>
<p>
<code><dest-dir>/<ant-type-group>/<ant-type>.html</code>
</p>
<p>
The default destination directory is "<code>.</code>".
</p></dd>
<dt><code>-splitindex</code></dt>
<dd>Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index
entries that start with non-alphabetical characters.</dd>
<dt><code>-docencoding</code> <var>charset</var></dt>
<dd>The charset to use when writing the HTML files. The default is the JVM default charset, "${file.encoding}".</dd>
<dt><code>-charset</code> <var>name</var></dt>
<dd>The HTML character set for this document.</dd>
<dt><code>-doctitle</code> <var>html-text</var></dt>
<dd>The title to place near the top of the overview summary file. The text specified in the title tag is placed as
a centered, level-one heading directly beneath the top navigation bar. The title tag can contain HTML tags and
white space.</dd>
<dt><code>-header</code> <var>text</var></dt>
<dd>The header text to be placed at the top of each output file. The header is placed to the right of the upper
navigation bar. The header can contain HTML tags and white space.</dd>
<dt><code>-footer</code> <var>text</var></dt>
<dd>The footer text to be placed at the bottom of each output file. The footer value is placed to the right of the
lower navigation bar. The footer value can contain HTML tags and white space.</dd>
<dt><code>-top</code> <var>text</var></dt>
<dd>The text to be placed at the top of each output file.</dd>
<dt><code>-bottom</code> <var>text</var></dt>
<dd>The text to be placed at the bottom of each output file. The text is placed at the bottom of the page,
underneath the lower navigation bar. The text can contain HTML tags and white space.</dd>
<dt><code>-quiet</code></dt>
<dd>Suppress normal output.</dd>
<dt><code>-notimestamp</code></dt>
<dd>Suppresses the time stamp, which is hidden in an HTML comment in the generated HTML near the top of each page.
This is useful when you want to run the javadoc command on two source bases and get the differences between diff
them, because it prevents time stamps from causing a diff (which would otherwise be a diff on every page).
The time stamp includes the javadoc command release number.</dd>
<dt><code>-antlib-file</code> <var>file</var></dt>
<dd>The ANTLIB file to parse, see <a href="https://ant.apache.org/manual/Types/antlib.html">the documentation of
the ANTLIB concept</a>.</dd>
<dt><code>-antlib-resource</code> <var>name</var></dt>
<dd>The name of an ANTLIB resource to parse, see <a href="https://ant.apache.org/manual/Types/antlib.html">the
documentation of the ANTLIB concept</a>.</dd>
<dt><code>-link</code> <var>external-documentation-url</var></dt>
<dd>See <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDEDJFI">the JAVADOC
tool documentation for the "-link" command line option</a>.</dd>
<dt><code>-linkoffline</code> <var>external-documentation-url</var> <var>package-list-location</var></dt>
<dd>See <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDFIIJH">the JAVADOC
tool documentation for the "-linkofflin" command line option</a>.</dd>
<dt><code>-tag</code> <var>spec</var></dt>
<dd>For compatibility with the standard JAVADOC doclet; ignored.</dd>
<dt><code>-theme</code> JAVA7|JAVA8</dt>
<dd>Which style sheets and resources to use.</dd>
<dt><code>-sourcepath</code> <var>source-path</var></dt>
<dd>Takes also effect for loading ANTLIB resources.</dd>
<dt><code>-classpath</code> <var>class-path</var></dt>
<dd>Takes also effect for loading ANTLIB resources.</dd>
<dt><code>-windowtitle</code> <var>text</var></dt>
<dd>See <a href="http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBIEEI">the JAVADOC
tool documentation for the "-windowtitle" command line option</a>.</dd>

</dl>

<h3>Supported tags:</h3>

<p>
The following block tags may appear in the DOC comment of a class declaration that maps to an ANT type:
</p>
<dl>
<dt><code>{@ant.typeGroupName <var>type-group-name</var>}</code></dt>
<dd>
The name of the "type group" that the type belongs to, e.g. "<code>Task</code>".
</dd>
<dt><code>{@ant.typeGroupSubdir <var>dir-name</var>}</code></dt>
<dd>
The name of the subdirectory that contains the documentation of all ANT types of the type group; e.g.
"<code>tasks</code>".
</dd>
<dt><code>{@ant.typeGroupHeading <var>text</var>}</code></dt>
<dd>
The heading to display above the list of types; e.g. "<code>Tasks</code>".
</dd>
<dt><code>{@ant.typeTitleMf <var>message-format</var>}</code></dt>
<dd>
The message format to use to render the heading on each type details page; e.g. <code>"Task
&quot;&lt;{0}&gt;&quot;"</code>
</dd>
<dt><code>{@ant.typeHeadingMf <var>message-format</var>}</code></dt>
<dd>
The message format to use to render the title (i.e. the tooltip) of the heading on each type details page;
e.g. <code>"Task &amp;quot;&lt;code>&lt;{0}&gt;&lt;/code>&amp;quot;"</code>
</dd>
<dt><code>{@ant.group <var>group-name</var>}</code></dt>
<dd>
Attributes (or subelements) with equal <var>group-name</var> are grouped, and the <var>group-name</var> is rendered as a heading above the group.
</dd>
<dt><code>{@ant.subelementOrder inheritedFirst}</code></dt>
<dd>
Enforces that the subelements <em>inherited</em> from superclasses appear <em>before</em> the non-inherited.
The default is that the subelements in their "natural" order.
</dd>
</dl>
</html>

== Features ==

=== Basics ===

The doclet parses the "[https://github.com/aunkrig/antology/blob/master/antology/src/main/resources/de/unkrig/antology/ant.xml ANTLIB file]" of your ANTLIB to identify all the tasks, types, chainable readers etc. that the ANTLIB implements. Then it finds the attribut setter and subelement adder methods, just like ANT would do. Eventually it generates one HTML page for each task, type, chainable reader etc., plus various overview, summary, index and frameset pages; very similar to what the standard JAVADOC servlet does for a set of Java classes.

References to attribute setter and subelement adder methods are not rendered as "<Code>setFoo(String)</code>" and "<code>addPerson(Person)</code>", but like "<code>foo=...</code>" and "<code><person></code>".

Links to the various standard ANT types are recognized and rendered appropriately.

=== Related attributes ===

Sometimes you want to document multiple attributes ''together'', i.e. have only ''one'' description. To get that, write a doc comment with a description for the ''first'' setter, and for the other setters a doc comment with a ''sole'' @see tag that refers to the first setter. Here is an [http://antology.unkrig.de/antdoc/tasks/swingLookAndFeel.html#attributes_summary example].

=== Grouping of attributes and subelements ===

Attribute setter methods ("<code>set*()</code>") and subelement adder methods ("<code>add*()</code>", "<code>addConfigured*()</code>" and "<code>create*()</code>") can have a "<code>@ant.group</code> ''group-name''" block tag in their DOC comment. If at least one attribute setter method (resp. subelement adder method) has such a block tag, then the attributes (resp. subelements) are grouped by ''group-name'', and each group gets a respective heading, and the subelements without a <code>@ant.group</code> go into a group "Other".

=== Attribute value documentation ===

The ANT doclet visualizes the meaning, the possible values and the default values for each attribute. The meaning is derived from the method parameter type and name (or the <code>@ant.valueExplanation</code> block tag); the possible values (for enums) from the enum constants, and the (optional) default value from the method parameter type and the <code>@ant.defaultValue</code> block tag.

The <code>@ant.mandatory</code> block tag appends " (mandatory)" to the attribute description title.

=== Custom type groups ===

The ANT doclet analyzes the types and, based on the interfaces they implement, assigns them to "type groups", which will later appear in the left-hand-side frame. The well-known type groups are: "Tasks", "Resource collections", "Chainable readers", "Conditions and "Other types". It is also possible to assign types to your own custom type groups, by adding the following block tags to the type:

/**
* This type lives in a custom "type group". For this example, we re-use the values for the "Tasks" type group -- please use your own instead.
*
* @ant.typeGroupSubdir tasks
* @ant.typeGroupName Task
* @ant.typeGroupHeading Tasks
* @ant.typeTitleMf Task "&lt;{0}&gt;"
* @ant.typeHeadingMf <code>&lt;{0}&gt;</code>
*/

=== Ordering of subelements ===

If an ANT type (e.g. a task) or a subelement has this block tag

/**
* @ant.subelementOrder inheritedFirst
*/

, then the subelements inherited from superclasses and interfaces are rendered ''before'' the subelements of the actual class. The default behavior is the other way round.

== Resources ==

The doclet JAR file is [https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=de.unkrig&a=doclet-ant&v=LATEST&c=jar-with-dependencies here].

Find the source code for the doclet [https://github.com/aunkrig/doclet-ant here].

== Change Log ==

; Version 1.0.5, 2016-11-25:
:* ANTLIB includes are now looked up through the javadoc sourcepath AND the javadoc classpath.
:* Modified the text of the copyright notice slightly: Replaced "author" with "copyright holders and contributors".

; Version 1.0.4, 2016-11-15:
:* The "-doctitle" command line option had no effect.

; Version 1.0.3, 2016-11-07:
:* Allow for multiple "-antlib-file" options.
:* Also process NESTED antlib files.

== License ==

The ANT doclet is available under the terms of the "new BSD license":

Copyright (c) 2015, Arno Unkrig
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of no-template nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Doclet

2024-05-01T18:33:09Z

Aunkrig: Created page with "This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy! == The ANT Doclet == Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs. The motivation for writing this doclet is to ease the maintenance of the documentation for the Antology antlib. Read more... == The CheckStyle Doclet == Generates (JAVADOC-like) HTML documentation and the..."

This site makes several doclets publicly available which I wrote for my personal needs, but are hopefully useful for others. Enjoy!

== The ANT Doclet ==

Generates (JAVADOC-like) HTML documentation for [http://ant.apache.org APACHE ANT] antlibs.

The motivation for writing this doclet is to ease the maintenance of the documentation for the [[Antology]] antlib.

[[ANT doclet|Read more...]]

== The CheckStyle Doclet ==

Generates (JAVADOC-like) HTML documentation and the metadata files for [http://checkstyle.sf.net CheckStyle] and [http://eclipse-cs.sf.net Eclipse-CS] plugin-ins from "doc tags" in the source code of your checks and filters.

[[Cs-doclet|Read more...]]

== The JAVADOC Doclet ==

A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use [https://github.com/aunkrig/no-template the "no-template" framework].

[[JAVADOC doclet|Read more...]]

== The MAIN Doclet ==

Generates an HTML page for the <code>main(String[])</code> method (or any other method) of each of the specified classes. This is useful for command line tools with a set of command line options. Converted to plain text (e.g. with the [[html2txt]] utility), that documentation is perfect for a self description that a command line utility would print in response to <code>--help</code>.

[[MAIN doclet|Read more...]]

Commons.unkrig.de

2024-05-01T18:31:57Z

Aunkrig: Created page with "<tt>de.unkrig.commons</tt> is a versatile Java™ library that implements many useful container and utility classes. It extends and integrates seamlessly with the standard JDK library. == Overview == <tt>de.unkrig.commons</tt> is structured in several modules who's names are aligned to the related packages in the JDK libraries. == Module Details == === commons-asm === Helper classes that are useful in the context of [http://forge.ow2.org/projects/asm/ ASM], a Ja..."

<tt>de.unkrig.commons</tt> is a versatile Java™ library that implements many useful container and utility classes.
It extends and integrates seamlessly with the standard JDK library.

== Overview ==

<tt>de.unkrig.commons</tt> is structured in several modules who's names are aligned to the related packages in the JDK libraries.

== Module Details ==

=== commons-asm ===

Helper classes that are useful in the context of [http://forge.ow2.org/projects/asm/ ASM], a Java bytecode manipulation library.

''Resources:''
[http://commons.unkrig.de/commons-asm/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=pom Maven POM]

=== commons-doclet ===

Helper classes that are useful for those who write [http://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html doclets].

''Resources:''
[http://commons.unkrig.de/commons-asm/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-asm&v=LATEST&e=pom Maven POM]

=== commons-file ===

Functionality for
[http://commons.unkrig.de/commons-file/apidocs/index.html?de/unkrig/commons/file/fileprocessing/package-summary.html processing]
or
[http://commons.unkrig.de/commons-file/apidocs/index.html?de/unkrig/commons/file/filetransformation/package-summary.html transforming]
trees of directories, files, compressed and archive files, and even nested compressed and archive files. Supports more than a dozen compression and archive formats.

''Resources:''
[http://commons.unkrig.de/commons-file/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-file&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-file&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-file&v=LATEST&e=pom Maven POM]

=== commons-io ===

Functionality around byte streams and readers/writers, e.g. for converting a byte stream into a hex dump, or formatting an XML document.

''Resources:''
[http://commons.unkrig.de/commons-io/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=pom Maven POM]

=== commons-junit4 ===

Assertions etc. for those who write tests with JUNIT 4.

''Resources:''
[http://commons.unkrig.de/commons-io/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-io&v=LATEST&e=pom Maven POM]

=== commons-lang ===

* Utility classes for [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/ExceptionUtil.html exceptions], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/ThreadUtil.html threads] and [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/RunnableUtil.html runnables]
* [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/package-summary.html "Protocol" interfaces] like [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Producer.html Producer], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Consumer.html Consumer], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Predicate.html Predicate], [http://commons.unkrig.de/commons-lang/apidocs/index.html?de/unkrig/commons/lang/protocol/Transformer.html Transformer]

''Resources:''
[http://commons.unkrig.de/commons-lang/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-lang&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-lang&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-lang&v=LATEST&e=pom Maven POM]

=== commons-math ===

[http://commons.unkrig.de/commons-math/apidocs/index.html?de/unkrig/commons/math/package-summary.html de.unkrig.commons.math]: A linear congruential generator; a [http://commons.unkrig.de/commons-math/apidocs/index.html?de/unkrig/commons/math/Sequences.html random sequence generator]

''Resources:''
[http://commons.unkrig.de/commons-math/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-math&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-math&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-math&v=LATEST&e=pom Maven POM]

=== commons-net ===

* [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/http/package-summary.html HTTP] and [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/ftp/package-summary.html FTP] servers and clients
* Various networking tools like [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/tool/tcpmon/package-summary.html TCPMON], [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/tool/ftpmon/package-summary.html FTPMON], [http://commons.unkrig.de/commons-net/apidocs/index.html?de/unkrig/commons/net/tool/telnet/package-summary.html TELNET]

''Resources:''
[http://commons.unkrig.de/commons-net/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-net&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-net&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-net&v=LATEST&e=pom Maven POM]

=== commons-nullanalysis ===

* Annotations and utility classes for ECLIPSE annotation-base "null analysis".

''Resources:''
[http://commons.unkrig.de/commons-nullanalysis/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-nullanalysis&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-nullanalysis&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-nullanalysis&v=LATEST&e=pom Maven POM]

=== commons-reflect ===

Various utilities for Java's reflection API.

''Resources:''
[http://commons.unkrig.de/commons-reflect/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-reflect&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-reflect&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-reflect&v=LATEST&e=pom Maven POM]

=== commons-text ===

* An [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/expression/ExpressionEvaluator.html expression evaluator]
* A small framework for creating [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/scanner/package-summary.html scanners] and [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/parser/package-summary.html parsers]
* A [http://commons.unkrig.de/commons-text/apidocs/index.html?de/unkrig/commons/text/pattern/Glob.html Glob] class that combines the widely known elements of UNIX file name globbing with the power of regular expressions

''Resources:''
[http://commons.unkrig.de/commons-text/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-text&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-text&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-text&v=LATEST&e=pom Maven POM]

=== commons-util ===

* [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/CommandLineOptions.html CommandLineOptions] makes parsing and documentation of command line options (e.g. for "<code>public static void main(String[])</code>") easy; see the [[CommandLineOptions tutorial|tutorial]].
* [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/TimeTable.html TimeTable] parses and implements a CRON-like specification string
* Various [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/filter/package-summary.html filters], [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/handler/package-summary.html handlers] and [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/formatter/package-summary.html formatters] for <tt>java.util.logging</tt>
* The [http://commons.unkrig.de/commons-util/apidocs/index.html?de/unkrig/commons/util/logging/SimpleLogging.html SimpleLogging] facility for easy integration of <tt>java.util.logging</tt> within command line tools

''Resources:''
[http://commons.unkrig.de/commons-util/apidocs/index.html JAVADOC],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-util&v=LATEST&e=jar JAR file Download],
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-util&v=LATEST&c=sources Source code Download]
[http://oss.sonatype.org/service/local/artifact/maven/redirect?r=releases&g=de.unkrig.commons&a=commons-util&v=LATEST&e=pom Maven POM]

== Source Code ==

The source code is available through GITHUB:

https://github.com/aunkrig/commons/

== License ==

COMMONS.UNKRIG.DE is published under the "[[New BSD License]]".

== Change Log ==

; Version 1.2.18 2022-12-28:
:* de.unkrig.commons.file.resourceprocessing.ResourceProcessings: Added "ResourceProcessings.STDIN_URL".
:* de.unkrig.commons.file.resourceprocessing.ResourceProcessings: ZZDIFF can now handle "-" (stdin) as one of its two inputs.
:* de.unkrig.commons.text.scanner: Added "setInput(input, int start, int end)" for scanning partial strings.
:* de.unkrig.commons.text.expression.ExpressionEvaluator: Added "parsePart(String spec, int[] offset, int end)" for parsing partial strings.
:* de.unkrig.commons.text.pattern.ExpressionMatchReplacer: Added "\Q...\E" and "\Q...".
:* ExpressionMatchReplacer.parseExt(): Added "\xhh", "\uhhhh", "\x{h...h}" and "normal" escapes ("\r", "\n", asf.).

; Version 1.2.17 2022-07-22:
:* d.u.c.lang.Characters: Small fixes of character classes for JRE 8 backwards compatibility.
:* d.u.c.lang.PrettyPrinter: Fixed one NPE in "PrettyPrinter.getPrettyClassName()" (handling of classes without a canonical name).
:* d.u.c.lang.StringUtil: Added multi-needle variants of "boyerMooreHorspoolIndexOf()", e.g. "needle1|[Nn]eedle2".
:* Added tests for "MapUtil.lazyMap()".
:* d.u.c.util.collections.MapUtil: Created a brother method "MapUtil.lazyMap(Map<K, Producer<? extends V>> valueGetters)" for "MapUtil.lazyMap(Map<K, Function<? super I, ? extends V>> valueGetters, @Nullable final I in)".
:* d.u.c.util.collections.IteratorUtil: Added "IteratorUtil.concat(List<Iterator>)".
:* d.u.c.util.CommandLineOptionException: Include "toString()" of the cause into the OptionProcessingException's message, because the cause's "getMessage()" is often not verbose enough.
:* d.u.c.text.expression.ExpressionEvaluator: Implemented the special attributes "_attributes", "_properties", "_staticAttributes" and "_staticProperties".
:* d.u.c.text.expression.ExpressionEvaluator: Arrays are now silently pretty-printed in all places.
:* Added "ObjectUtil.arrayToString(Object)".
:* d.u.c.lang.protocol.ConsumerUtil: Moved "Grep.lineCounter()" to "ConsumerUtil".
:* d.u.c.text.pattern.PatternUtil: Added to the "patternFinderWriter()" method family some more with a "Runnable flush" parameter.
:* d.u.c.text.pattern.Finders: Added to the "patternFinder()" method family some more with a "Runnable flush" parameter.
:* d.u.c.lang.protocol.Functions: Added "Functions.constant(O)".
:* d.u.c.io.ConsumingWriter: Added the "ConsumingWriter".
:* d.u.c.text.pattern.Substitutor: The Substitutor is now based on the Finders.patternFinder().
:* d.u.c.text.pattern.PatternUtil: The object returned by "replacementStringMatchReplacer()" didn't have a proper "toString()" method.
:* d.u.c.file.org.apache.commons.compress.archivers: "ArchiveFormat.forArchiveOutputStream(ArchiveOutputStream)" didn't work in all cases.

; Version 1.2.16 2022-03-21:
:* Iff the field "Throwable.message" cannot be made accessible, print a useful warning message on STDERR instead of throwing an exception.
:* Gave up on Java 6 compatibility... now Java 8.
:* Added "setPassword()", in addition to the system property.
:* Gave up on Java 6 compatibility... now Java 8.
:* Added "MavenUtil".
:* Reverted the commit of "Glob.java" of 2021-12-01 19:22: "%" is *not* a valid suffix; otherwise all compressed contents (e.g. "dir/file.gz%") would match a pattern like "***foo".
:* Added test case for "FileProcessings.starterFile(String regex)".
:* Added "ContentProcessings.glob()".
:* Added "PatternUtil.constantPrefix()".
:* Added "FileProcessings.glob()".
:* Added "OutputStreams.newOverwritingFileOutputStream(File)": "$xyz" was handled differently from "${xyz}" and caused an NPE.
:* Added "AbstractParser.readEnum()".
:* Gave up on backwards compatibility with Java 6 and 7 (removed substitutes for java.util.Base64).
:* Added "Readers.readFully()".
:* Added "InputStreams.readFully()".
:* Set "useTransparentBounds(true)" when scanning, so token regexes can use lookaheads and lookbehinds.
:* Eliminated the terrible hack where STORED zip archive entries were silently transformed into DEFLATED (because STORED entries need a correct SIZE and CRC, and these were difficult to calculate). Implemented this with a temporary storage using an "elastic pipe".
:* Added "OutputStreams.updatesChecksum(final Checksum checksum) => OutputStream".
:* The substitution count was wrong (*2 value).
:* Typo in "elasticPipe()" caused an IllegalStateException.
:* Added "ArchiveFormat.getCompressionMethod(ArchiveEntry)", which returns a string representation of the compression method used for the archive entry.
:* Generating TAR archives: The "long file mode" (determines the handling of file names longer than 100 characters) can now be controlled with a system property "TarArchiveFormat.longFileMode"; the default is now "GNU" (and not, as before, "ERROR").
:* Added "Numbers.unsignedCompareToByte/Short/Int/Long()".
:* Added the "Relation" interface and the "Relations" utility class.

; Version 1.2.15 2020-11-06:
:* commons-file: Implemented decryption of encrypted 7ZIP archives with a sysem property "sevenZInputFilePassword".
:* commons-file: Directory processing: JRE11+MS WINDOWS replace colons (#003A) in member names with #F03A, for whatever reason.
:* commons-net: For method CONNECT, the second word of the request line is not a URI, but only an authority (host:port).
:* commons-file: Handle AR archive entriy with empty name: Silently rename it to "__ROOT".
:* commons-net: Fixed one resource leak.
:* commons-file: "apache.commons.compress" no longer seems to miss the dependency on "org.tukaani" -- removed the workaround.
:* commons-file: Augmented all content processing with an optional "lastModifiedDate" parameter.
:* commons-file: Added (read-only) support for the "rpm" archive format. (An PM file is actually a compressed CPIO archive preceeded by some binary metadata.)
:* commons-util: Added "MapUtil.lazyMap()".
:* commons-text: Added "Notation.Phrase.size()" and "Notation.Phrase.get()".
:* commons-io: Fixed an endless loop in "MarkableFileInputtream.skip()".
:* commons-io: Fixed a ConcurrentModificationException.
:* commons-text: Replaced single quotes in many messages with (the typographically more correct) double quotes.
:* commons-util: Wrap exceptions that occur during option processing with the new "OptionProcessingException" (instead of an AssertionError).
:* commons-io: Added "Writers.autoFlushing()" and "OutputStreams.autoFlushing()". Added "Readers.wye(Reader, Writer)" and marked "WyeReader" as deprecated.
:* commons-io, commons-lang: Added tons of "? super" and "? extends" clauses.

; Version 1.2.14 2019-10-11:
:* Fixed an IllegalArgumentException in "Pattern2.compile(String, int)" and "Glob.compile(String, int)".
:* StringStream: Made "next()" and "consume()" public.
:* OptionalMethods: All methods get an additional first parameter "@Nullable String message", which, if non-null, is used for the UnsupportedOperationException.
:* Added "XmlUtil.parse(DocumentBuilder, InputStream, String publicId, String encoding)".
:* Added "Writers.tee(Writer... delegates)".
:* ArArchiveFormat: Catch an NPE thrown by ArArchiveInputStream.
:* ArArchiveFOrmat: Catch a NumberFormatException in ArArchiveInputStream.
:* Work around "ZipException: uncompressed size is required for STORED method when not writing to a file"
:* commons.doclet.Html: Changed fragment style from Java 7 to Java 8+.
:* ResourceProcessings: "isFile()" did not decode %xx escape sequences in URLs.
:* commons.lang.Comparators: Added "Comparators.keyComparator()" and ".valueComparator()".
:* FileProcessings.directoryProcessor(): The "pathPredicate" was applied wrong for *files* (as opposed to directories). As a result, "zzgrep --include '***.class'" did not match .class files *in archives*.
:* InputStreams: Added "EventCounter", "ExponentiallyLoggingEventCounter" and "InputStreams.statisticsInputStream()" for real-time IO statistics.
:* Optimize archive file and compressed file reading by replacing small file READs with large file READs.
:* Added input stream statistics in "CompressUtil" and "FileContentsProcessor".
:* Fatal bug in "ConsumerUtil.head()" fixed!
:* Added "commons.lang.protocolTuple2", "Tuple3" and "Tuple4".
:* ExpressionMatchReplacer: Replaced "imports" with "singleImports" and "onDemandImports".
:* ExpressionEvaluator: Added scanning of MULTI-LINE C-style comments. Added scanning of C++-style comments.
:* Added "de.unkrig.commons.file.resourceprocessing", in symmetry with "fileprocessing" and "contentsprocessing", to process *resources* (designated by URLs) in addition to files and InputStreams.
:* commons.file: Compressed file names and compressed contents paths are now suffixed with '%' (instead of '!') to circumvent problems with "Glob"'s directory prefix mechanism.
:* Java 9 added "@Override public final CharBuffer CharBuffer.rewind() { ..." -- leads easily to a "NoSuchMethodError: java.nio.CharBuffer.rewind()Ljava/nio/CharBuffer"; a cast to "Buffer" is the workaround.
:* Added "LineUtil.lineAndColumnTracker()".
:* Added "Readers.onFirstChar()" and "Readers.trackLineAndColumn(Reader)".
:* Added "Writers.onFirstChar()" and "Writers.trackLineAndColumn(Writer)".
:* Removed unnecessary dependency on "de.unkrig.commons:commons-junit4".
:* CommandLineOptions: Convert "any" to InetAddr "null" ("wildcard address").

; Version 1.2.13 2018-11-23:
:* In analogy with the "Substitutor", the new "Search" class finds pattern matches in a sequence of chunks in a "sliding" manner. Instead of a "match replacer", it invokes a "match handler".
:* Breaking change: A "match replacer" is no longer a "FunctionWhichThrows<Matcher, String, EX>", but a "FunctionWhichThrows<MatchResult, String, EX>".
:* Added support for HTTP method "OPTIONS".
:* Refined the logic that checks for "Socket closed" exceptions.

; Version 1.2.12 2018-10-29:
:* ChunkedInputStream: Reading of blank line after last chunk was missing.
:* Added "LevelFilteredPrinter.setNoErrors()".
:* Added "evaluateExpressionTo(@Nullable String[] imports, String input,Class<T> targetType, Mapping<String, ?> variables)".
:* Added convenience methods with a parameter "Object... variableNamesAndValues" for all methods with a parameter "Mapping<String, ?> variables".
:* Added "or(PredicateWhichThrows<? super T, ? extends EX> lhs, PredicateWhichThrows<? super T, ? extends EX> rhs)" as a brother of "or(Predicate<? super T> lhs, Predicate<? super T> rhs)".
:* Added "containsKeyPredicateWhichThrows(final Mapping<K, V>)".
:* Removed the "<EX>" type parameter from "ExpressionEvaluator.parser(String spec)".
:* Optimized "toPredicate()" and "constantExpression()" for the special cases "true", "false" and "null".
:* Replaced "HttpAuthenticationServlett(String realm, String userName, String password)" with "HttpAuthenticationServlett(String realm, UserNamePasswordPredicate)".
:* Added "removeParameter()".
:* Added test cases for "de.unkrig.commons.util.Enums".
:* Optimized performance of "Enums.valueOf(String, Class<? extends Enum>)".
:* Added "enumSetFromString(String, Class<? extends Enum>)" and "valueOf(String, Class<? extends Enum>)".
:* Started implementation of "IndexOf.indexOf(CharSequence haystack, int minIndex, int maxIndex, int limit)" for partial terminal matches.
:* Added method "toCharArray(CharSequence cs)".
:* Added "of(T... values)", "union(Set<? extends T> lhs, Set<? extends T> rhs)" and "intersection(Set<? extends T> lhs, Set<? extends T> rhs)".
:* Added "toCharArray(Set<Character>)" and "toIntArray(Set<Integer>)".
:* Added "append(char[] a, char... values)" and "mirror(char[][])".
:* Fixed up several bugs in "boyerMooreHorspool...()".
:* Renamed methods "knuthMorrisPratt...()" to "boyerMooreHolbrook...()".
:* Fixed up the Knuth-Morris-Pratt "lastIndexOf()" method.
:* More optimization on the "knuthMorrisPratt()" index-of algorithm.
:* Renamed the "...Index" parameters of the "IndexOf.(indexOf|lastIndexOf)()" methods from "(from|to)Index" to "(min|max)Index", because "from" and "to" are very confusing for "lastIndexOf()".
:* Utility functionality related to {@link HttpsURLConnection}s.
:* Added "ExpressionEvaluator.parsePart()".
:* Added "ExpressionEvaluator.parsePart()".
:* "getMostSpecificMethod()": Didn't find some methods declared in superinterfaces.
:* Added "containsKeyPredicate(Mapping)".
:* The non-"...WhichThrows" protocol classes now declare the EX type parameter as "NoException" (was "RuntimeException") to make any code more self-documenting.
:* "isLessSpecific()": The synthetic methods that are generated for covariant return values were regarded as "ambiguous".
:* The "transformer" argument is now allowed to throw IOExceptions.
:* "copyAndTransform()" now declares an "EX" type parameter.
:* Added the "assertFind()" methods.
:* Added "StringUtil.asJavaLiteral(String)".
:* Added "IterableUtil.addAllElementsTo(Iterable, Collection)" and "IteratorUtil.addAllElementsTo(Iterator, Collection)".
:* Moved "EMPTY_SORTED_SET" and "emptySortedSet()" from "CollectionUtil" to "Sets", leaving (deprecated) wrappers behind.

; Version 1.2.11 2017-08-23:
:* Added methods "Rule.goTo(S)", "Rule.push(S)" and "Rule.pop()", making many of the "StatefulScanner.addRule(...)" methods DEPRECATED.
:* Added utility class "OptionalMethods".
:* Made JRE 7's methods "isAlphabetic(int)" and "isIdeographic(int)" available for all JRE versions.
:* "Token.captured" is no longer @Nullable; this is much more practical.
:* Added "PrettyPrinter.codePointToString(int)".
:* Added the following methods, and the plethora of predicates that implement them:
:** javaCharacterClassFromName(String)
:** unicodeCategoryFromName(String)
:** unicodeBinaryPropertyFromName(String)
:** unicodePredefinedCharacterClassFromName(String)
:** posixCharacterClassFromName(String)
:* Improved the "unexpected character" exception message by adding information about the current scanner state.
:* Added the "de.unkrig.commons.util.EnhancedServiceLoader".
:* Added appropriate "toString()" methods on "IndexOf" implementations.
:* Extended the "StringUtil.IndexOf" interface with various "lastIndexOf()" methods.
:* Added "StringUtil.newIndexOf(final String infix)" which implements the Knuth-Morris-Pratt algorithm.

; Version 1.2.10 2017-07-30:
:* Added method "MD5.of(InputStream)".
:* Added utility class "de.unkrig.commons.lang.Comparators".
:* CompressUtil: The "UnsupportedZipFeatureException" was not properly wrapped because it has none of the "usual" constructors that "ExceptionUtil.wrap()" requires.
:* Added "InputStreams.readAll(InputStream, boolean closeInputStream)".
:* de.unkrig.commons.util.collections.Peekerators: Introduced the concept of the "peekerator" - an Iterator with a "peek()" method.
:* IterableUtil: Added "IterableUtil.NATURALS" and "NATURALS0".
:* de.unkrig.commons.util.collections: Added methods "IteratorUtil.foR(...)" and "IterableUtil.foR(...)".
:* de.unkrig.commons.util.collections: Moved "iteratorWithContext()" from IterableUtil to IteratorUtil.
:* de.unkrig.commons.util.collections: Made "ElementWithContext" a top-level type, because it is now used by two compilation units (IteratorUtil and IterableUtil).
:* commons-net and commons-util: Moved the "CustomAuthenticator" (and its fellows "CredentialsSpec", "JPasswordFields" and "Regex" from the ANTOLOGY project to the "de.unkrig.commons.net" project, where it belongs.
:* CommandLineOptions: Gave "printResource(Class, String relativeResourceName, ...)" a sibling method "printResource(ClassLoader, String resourceName, ...)".
:* de.unkrig.commons.net.http.HttpMessage: In "attempt unstreaming" mode, the body was written TWICE (caused IllegalStateExceptions).
:* de.unkrig.commons.net.http: Added support for the "CONNECT" method.
:* Added to many methods parameter(s) "xxxLoggingPrefix" so that one can customize the logging messages. By default, logging messages related to incoming data are prefixed with ">>> ", and logging messages related to outgoing data with "<<< ".
:* HttpMessage: The "attempt unstreaming" feature can now be switched off (important for the CONNECT method).
:* "IoUtil.copy()" now flushes the output stream when the next READ from the input stream will block.
:* de.unkrig.commons.text.expression: Added support for nested types.
:* Changed the return types of "Expression.evaluateTo[Primitive](...)" from "Object" to "T".
:* AuthenticateHeaderParser: Implemented BASIC authentication for the "HttpClient" - useful to configure HTTP proxies that handle authentication.
:* unkrig.commons/text/scanner: Added "String[] Token.captured" for access to input subsequences that were captured during the token match.
:* ConsumerUtil: Added methods "head(m)" and "tail(n)".
:* "Transformer" now extends "TransformerWhichThrows<I, O, RuntimeException>", as it always should have done.
:* Added "BooleanProducer ProducerUtil.once()".
:* Added the "de.unkrig.commons.text.scanner.XmlScanner" class and tests.
:* Added "StringUtil.containsAny(String subject, String characters)", which checks whether the subject contains any of the characters.
:* Added the "FilterAppendable", very much in anaolgy with the "java.io.FilterWriter".
:* Added "CharSequences.from(char[])" and "CharSequences.from(char[], int off, int len)".
:* Added the "Appendables" utility class.
:* de.unkrig.commons.doclet.html.Html: Added support for {@value} on enum constants.
:* de.unkrig.commons.doclet.html.Html: STANDARD_LINK_MAKER: Added support for links to enum constants.
:* de.unkrig.commons.text.expression.ExpressionEvaluator: Breaking API change: "evaluateTo(..)" now returns a _nullable_ result.
:* ConsumerUtil: Added various "store()" and "cumulate()" methods.
:* de.unkrig.commons.net.http.HttpMessage: Added method "body(final ProducerWhichThrows<InputStream, IOException> in)".
:* Automatic XML formatting is now not only active for content type "text/xml", but for any content type with an infix "xml".
:* de.unkrig.commons.io.ReaderInputStream: First implementation of the "ReaderInputStream" as the complement of the "WriterOutputStream"; as of now supports only char set ISO8859-1.
:* TransformingFilterReader: Bug fixed: "TransformingFilterReader.read()" returned -1 on the first pattern match.
:* de.unkrig.commons.doclet.html.Html: @value: The argument was not SGML-Escaped.
:* TransformerUtil: Added "cache(final Transformer<? super I, O> delegate, final Map<I, O> cache)".
:* ContentsProcessings.processArchive(): "Directory archive entries" are now silently ignored, because they have no contents and thus it makes no sense to process them with the "contentsProcessor".
:* FileUtil: Added a workaround for MS WINDOWS 7: Read-protected directory produces: isDirectory() => true; canRead() => true; list() => null; listFiles() => null (Caused NPEs.)
:* PasswordAuthenticationStores: "..customAuthenticator_credentials,orig" file was not deleted after saving the credentials properties file.

; Version 1.2.9 2017-02-02:
:* de.unkrig.commons.crypto/security: Gave up on the concept of "DestroyableString"s - they cause more confusion than they are helpful.
:* ProducerUtil: Fixed a serious bug in "cacheAsynchronously()": ExecutionExceptions thrown by the Future were not handled properly and caused the cache to "hang".
:* Added "roundRobin()".

; Version 1.2.8 2017-01-27:
:* New utility class "AssertString": Provides methods like "assertContains(String expectedInfix, String actual)".
:* Added a new package "de.unkrig.commons.lang.crypto", and moved many classes from "lang.security" to there.
:* Extracted the UserNamePasswordStore from "de.unkrig.antology.task.SetAuthenticatorTask" to here.
:* Added "StatefulScanner.getCurrentState()" and "setCurrentState()" so that the state of the scanner can be changed from outside admidst scanning.
:* Added "AbstractScanner.suppress(TT)" and "suppress(EnumSet<TT>)".
:* Added "ProducterUtil.filter(Producer, Predicate)".
:* StatefulScanner: Declared a constant "REMAIN" for the "addRule()" methods that have a final "nextState" parameter.
:* AbstractParser: End-of-input handling was brooken in "read(Object... tokenTypeOrText)".
:* Added the "de.unkrig.commons.lang.Characters" utility class.
:* The first parameter of methods "StatefulScanner.addRule(EnumSet<S>, ...)" is now NULLABLE, where "null" means "any state, including the default state".
:* Added a constructor "StatefulScanner(StatefulScanner)" that clones the configuration, but not the state.
:* StatefulScanner: Added methods "addRule(@Nullable EnumSet<S> states, String regex, TT tokenType)" and "addRule(@Nullable EnumSet<S> states, String regex, TT tokenType, S nextState)", which make it easier to declare rules that apply in more than one non-default states.
:* Fixed one major design error in "CommandLineOptions": Method "applyCommandLineOption()" now gets a "Method" as its second parameter, instead of, previously, a "CommandLineOption" object.

; Version 1.2.7 2016-12-12:
:* IoUtil: Added "singlingFilterReader()" and "singlingInputStream()".
:* PatternUtil: Fixed several bugs in "PatternUtil.replaceAll()".
:* PatternUtil: Added "replaceAllFilterReader()".
:* PatternUtil: Added "replaceAllFilterWriter()".
:* Moved many, many methods from "IoUtil" to the new utility classes "InputStreams", "OutputStreams", "Readers", "Writers" and "FransformingFilter(Reader|Writer)".
:* Added "StringTransformers", a collection of simple "Transformer<CharSequence, CharSequence>"s.
:* Added TransformerUtil.chain(Transformer...)".
:* Extracted "PatternUtil.replaceAllFilterReader()" as the new "Substitutor" class.
:* Adapted to the refactoring of "IoUtil".
:* Added unit tests for the "Substitutor".
:* "IoUtil.findOnPath()": The search stopped at the FIRST archive file.

; Version 1.2.6 2016-11-30:
:* commons-io: Added the "CharFilter", "CharFilterReader" and "CharFilterWrite", which are the char-wise equivalent of "ByteFilter(InputStream|OutputStream)?".
:* Glob: Added the "" special case for the "container match".
:* FileProcessings, ContentsProcessings: The "pathPredicate" was missing from content processors.

; Version 1.2.5 2016-11-28:
:* Printers: Added "Printers.redirectToFile(Level|EnumSet<Level>)".

; Version 1.2.4 2016-11-25:
:* IoUtil: Fixed one MalformedURLException.
:* Added the "ByteFilterOutputStream", as a complement to the "ByteFilterInputStream".
:* ContentsTransformations: Added methods "chain(ContentsTransformer, ContentsTransformer)", "asInputStream(InputStream delegate, ContentsTransformer, String)" and "asOutputStream(ContentsTransformer, OutputStream delegate, name)".
:* Added "SelectiveContentsTransformer.create()", which can conduct many optimizations.
:* Workover of the "Printers" API: A lot of functionality went from "Printers" to "AbstractPrinter"; the old methods, however, remain, and are now marked as @deprecated.
:* IoUtil: Added methods "findOnPath(File[], String resourceName)" and "copyTree(URL, File)".
:* Added "de.unkrig.commons.lang.ClassLoaders".
:* Slightly clarified the wording of the license: Replaced "author" with "copyright holder and its contributors".

; Version 1.2.3, 2016-11-07:
:* commons-file: The "formats" files didn't make it into the JAR, because they were in "src/main/java" instead of "src/main/resource".

; Version 1.2.2, 2016-11-07:
:* XmlUtil.parse(): Detect and throw IOExceptions (esp. FileNotFoundException) properly.
:* commons-junit4: Removed the unnecessary dependency on "org.apache.commons:commons-compress".
:* For unknown reasons, the POM of org.apache.commons:commons-compress fails to declare the dependency on "org.tukaani:xz", although it definitely depends on it. Thus added the dependency in "de.unkrig.commons:commons-file"'s POM.
:* "IoUtil.parallel()", as a side effect, caused the JVM to not terminate when it is shut down orderly (i.e. "main()" returns or "System.exit()" is invoked).
:* Added "ThreadUtil.DAEMON_THREAD_FACTORY".

; Version 1.2.1, 2016-10-30:
:* Removed the nasty circular dependencies around "commons-junit".

; Version 1.2.0, 2016-10-24:
:* Replaced the old ANT build with MAVEN.

; Version 1.1.12, 2016-10-14:
:* Bug fixes in "ProducerUtil.cache()".

; Version 1.1.11, 2016-08-13:
:* ProducerUtil.cache...(): The "invalidationCondition" was treated the wrong way around in some places. Pulled things straigt.
:* PredicateUtil: Added method "static synchronizedPredicate(Predicate)".

; Version 1.1.10, 2016-08-12:
:* ProducerUtil.cache(): When the first call of "delegate.produce()" threw an exception, then the NEXT invocation returned NULL (instead of calling "delegate.produce()" again).
:* ProducerUtil: Added "cacheAsynchronously()" and "atMostEvery(ms, firstProduct, startAtTrueProduct)".

; Version 1.1.9, 2016-08-02:
:* Fixed the bounds of of the parameters of some "MapUtil()" methods, to make them more versatile.

; Version 1.1.8, 2016-07-26:
:* Moved various map-related methods from "CollectionUtil" to "MapUtil" (where they actually belong), marked the original methods with "@Deprecated" and replaced them with invocations of the "new" methods.
:* Moved a few more fields and methods from "CollectionUtil" to "IterableUtil" and "IteratorUtil", where they belong.
:* Added many missing bounds to method parameters to make the methods more flexible.

; Version 1.1.7, 2016-06-17:
:* Added "ObjectUtil.hashCode()".
:* Added "PredicateUtil.always(boolean)".
:* Added "PredicateUtil.xor()".
:* "Predicate<T>" now extends "PredicateWhichThrows<T, RuntimeException>".
:* Added "ProducerUtil.cache(delegate, condition)".
:* "commons/doclet": Added support for the inline tags "{@docRoot}", "{@literal}", "{@constantsof}" and "{@constantsofplain}".
:* CommandLineOptions: Initial support for "option cardinality" and "option group cardinality".
:* Added "de.unkrig.commons.util.Enums".
:* Added the "IdentityHashSet".
:* Added methods "Pipe.read(byte[])" and "Pipe.write(byte[])".
:* Changed type parameter "EX" of "(Consumer|Function|Predicate|Producer|Runnable|Transformer)WhichThrows" interfaces from "extends Exception" to "extends Throwable" to allow for seamless handlich of the "Longjump" throwable.
:* Added a static "ignoreExceptions()" method to the "(Consumer|Function|Predicate|Producer|Runnable|Transformer)Util" classes.
:* Longjump: Added various "catchLongjump()" methods for easy integration with Java 8 lambdas.
:* Added the following methods:
:** IoUtil.copy(File, File, CollisionStrategy)
:** IoUtil.copyTree(File, File, CollisionStrategy)
:** IoUtil.isContentIdentical(File, File)

; Version 1.1.6, 2016-03-21:
:* Added "ObjectUtil.almostNull()".

; Version 1.1.5, 2016-03-14:
:* de.unkrig.commons.io.IoUtil: Added "skip()" and "skipAll()".
:* de.unkrig.commons.text.PatternUtil: Replaced the "Replacer" interface with a "Function<Matcher, String>".
:* de.unkrig.commons.file.ExceptionHandler: Handler methods now have, for consistency with the other APIs, an additional parameter "String path".
:* de.unkrig.commons.net: TcpServer(SSLContext): Remove several "cipher suites" from the SSL context because otherwise some modern browsers refuse to connect with this server.

; Version 1.1.4, 2015-11-11:
:* de.unkrig.commons.text: JavaScanner/JsonScanner: The CXX_COMMENT now INCLUDES the trailing line break.
:* de.unkrig.commons.net: Added Utility class "UrlConnections", with the single method "followRedirects2()".
:* de.unkrig.commons.text: Replaced "CamelCase" with the more versatile "Notations" helper class.
:* de.unkrig.util.collections: Added the "Stack" interface and its implementation "ArrayStack".
:* de.unkrig.commons.lang: Added the "FunctionWhichThrows" interface and the "Functions" utility class.

; Version 1.1.3, 2015-09-19:
:* de.unkrig.commons.doclet: Removed the concept of generating MEDIAWIKI markup - MEDIAWIKI is for COLLABORATION, not for documentation.
:* Added "de.unkrig.commons.util.CommandLineOptions" for elegant command line processing.
:* Added "de.unkrig.commons.util.concurrent.ByteStreamSequentializer" and "ObjectSequentializer".

; Version 1.1.2, 2015-08-31:
:* Added optional dependencies on 'xz' and APACHE COMPRESS.
:* Added "de.unkrig.commons.doclet".
:* Added "de.unkrig.commons.text.xml".
:* Added "de.unkrig.commons.util.collections.IteratorUtil".
:* Various bug fixes in de.unkrig.commons.file
:* Added "de.unkrig.commons.file.contentstransformation.TextTransformer".
:* "de.unkrig.commons.file.fileprocessing" now supports parallel execution.
:* The "JavaScanner" now decodes unicode escapes - strictly speaking: wrong, but very useful in some situations.

; Version 1.1.1, 2015-02-24:
:* Gave up on Java 5 compatibility; Java >= 6 is now required.
:* UPDATE no longer takes two separate paramaters 'glob' and 'update-file', but one parameter 'glob=update-file', which makes it possible to use variable references when creating the 'update-file' name.
:* Push releases to OSSRH and eventually to MAVEN CENTRAL

; Version 1.1.0, 2015-02-04:
:* Major refactoring of 'de.unkrig.commons.file.fileprocessing' and 'de.unkrig.commons.file.contentsprocessing'.
:* de.unkrig.commons.file.filetransformation: Thanks to apache.commons.compress, we now not only support the ZIP archive format and the GZIP compression algorithm, but also the AR, ARJ, CPIO, DUMP, JAR, TAR and SEVEN_Z archive formats and the BZIP2, PACK200, XZ, LZMA, SNAPPY and Z compression algorithms.
:* Added 'de.unkrig.commons.lang.security.Sandbox'.

; Version 1.0.5, 2014-05-01:
:* Moved the <log>, <logging> and <simpleLogging> tasks from 'de.unkrig.commons.util' to 'de.unkrig.antcontrib'.

; Version 1.0.4, 2014-04-29:
:* 'keepOriginals' did not work for in-place file transformations.
:* <simplelogging>: Added attribute 'spec="..."'.
:* <simpleLogging>: Attribute 'debug="..."' no longer is boolean, but "FINE|FINER|FINEST".
:* <logging>: Removed attribute 'parent="..."'
:* <logging>: Added attribute 'clearFilter="true"'.
:* Renamed task <simplelogging> to <simpleLogging> (with a big 'L').

; Versions 1.0.3 and earlier:
: No change log available.

Cs-contrib.unkrig.de

2024-05-01T18:30:34Z

Aunkrig: Created page with "<meta name="keywords" content="checkstyle, checks, filters, quickfixes"></meta> <meta name="description" content="Custom checks, filters and quickfixes for checkstyle and eclipse-cs"></meta> = Introduction = This project adds custom checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS]. This project uses the CS doclet (internally) to generate its CheckStyle and eclipse-cs meta..."

Zz.unkrig.de

2024-05-01T18:25:10Z

Aunkrig: Created page with "<meta name="keywords" content="java, compressed, archive, zip, zipped, nested"></meta> <meta name="description" content="A set of command-line tools that handle not only directories and files, but also archive and compressed files, and even nested archive files"></meta> A set of command-line tools that handle not only directories and files, but also archive and compressed files, and even nested archive files. They can even disassemble Java <code>.class</code> files on-th..."

New BSD License

2024-05-01T18:23:26Z

Aunkrig: Created page with "Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: # Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. # Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution...."

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
following conditions are met:

# Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
# Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Antology Change Log

2024-05-01T18:22:34Z

Aunkrig: Created page with "===Version 2.0.6, 2019-08-05=== * In addition to "...-jar-with-dependencies.jar", generate a "...-antlib.jar" file, where the ANT classes are NOT included. * Added the "replacementExpression=..." to complement the "replacementString=...". ===Version 2.0.5, 2018-11-16=== * Added the "<httpsUrlConnections>" task. * Added the "<cookieHandler><print /></cookieHandler>" task. * Added the "<replaceAll pattern=... replacementString=... />" filter reader. * Added the "<cookieHa..."

===Version 2.0.6, 2019-08-05===
* In addition to "...-jar-with-dependencies.jar", generate a "...-antlib.jar" file, where the ANT classes are NOT included.
* Added the "replacementExpression=..." to complement the "replacementString=...".

===Version 2.0.5, 2018-11-16===
* Added the "<httpsUrlConnections>" task.
* Added the "<cookieHandler><print /></cookieHandler>" task.
* Added the "<replaceAll pattern=... replacementString=... />" filter reader.
* Added the "<cookieHandler><print /></cookieHandler>" task.
* <setCookieHandlerTask>: Don't clear the cookie store on repeated executions.
* Added the "<httpsUrlConnections>" task.
* Added the "<replaceAll pattern=... replacementString=... />" filter reader.

===Version 2.0.4, 2017-12-06===
* Tasks <follow> and <urlConnection>: Added attributes 'direct="true", 'httpProxy="host:port"' and 'socksProxy="host:port"', which override the "http[s].proxy(Host|Port)" system properties.
* Moved the "CustomAuthenticator" (and its fellows "CredentialsSpec", "JPasswordFields" and "Regex" from the ANTOLOGY project to the "de.unkrig.commons.net" project, where it belongs.
* Fixed the well-known security hole in JPasswordField: You can't set the password without converting it to a String.
* CustomAuthenticator: Treat port number "-1" as "missing".
* Task <setAuthenticator>: Added the "deny=..." attribute for the <credentials> subelement.

===Version 2.0.3, 2017-01-27===
* Switched from ANT 1.8.4 to 1.9.8.
* <forEach2>: The default for the "delimiter", which was previously changed from "," to ", \t\r\n", was reverted, and a new attribut "trim" was added.
* Extracted the Authenticator from the <setAuthenticator> task to an independent compilation unit.
* The keystore of <setAuthenticator> is now (optionally) protectable with a "master password".
* Extracted the UserNamePasswordStore to "de.unkrig.commons.lang.security".
* <setAuthenticator>: Credentials can now optionally be stored in a file "${user.home}/.antology_setAuthenticator_credentials".
* <ftp2>: Now also using the java.net.Authenticator for authentication.
* <setAuthenticator>: Multiple executions now AUGMENT credentials (instead of replacing them).
* <setAuthenticator>: Password authentications are now cached across executions, so the user is prompted at most ONCE for each <credentials> subelement.
* Changed the default delimiter from "," to ", \t\r\n".
* Task <ftp2>, method "sendFile()": Fix for an obvious bug in ANT 1.8.4: Verbose message "transferring a to b" swapped "a" and "b" (maybe the code was copied from method "getFile()"!?).

===Version 2.0.2, 2016-11-15===
* Added a small ANT build script that uploads the generated ANTDOC to a public web site.
* Fixed some commons-net test cases, so they succeed also in IPv6 environments.

===Version 2.0.1, 2016-10-17===
* Fixed the ANTDOC generation.

===Version 2.0.0, 2016-10-14===
* Renamed the project from "de.unkrig.ant-contrib" to "antology".
* Moved the source repository from "https://svn.code.sf.net/p/loggifier/code/trunk/de.unkrig.ant-contrib" to "https://github.com/aunkrig/antology/trunk/antology".
* Changed the build system from ANT to MAVEN.
* Renamed Java packages from "de.unkrig.antcontrib" to "de.unkrig.antology".

===Version 1.1.6, 2016-06-17:===
* Added the "<swingLookAndFeel>" task.

===Version 1.1.5, 2015-12-09:===
* <setAuthenticator>: The user/password dialog was unusable on one particular machine - added a workaround.
* The call to "setDoOutput(true)" was previously lost, inhibiting any POST and PUT requests.

===Version 1.1.4, 2015-12-02:===
* Output of the subtasks of "<forEach2>" and "<throughput>" now appears prefixed with "| ".
* <urlConnection>: In case of an exception, also report the duration of the attempt.
* <setAuthenticator>: Restored the original behavior where "no <credential> subelements" means "Always ask for user name AND password".

===Version 1.1.3, 2015-09-25:===
* Added ANTDOC generation to the build process.
* Fixed Dario's NPE in the <jsonProperty> task (again, sigh).

===Version 1.1.2, 2015-09-24:===
* <jsonProperty> task: Fixed an NPE.
* <swingDialog> task: May contain character data as an alternative to the <label>, <text>, <textField>, <textArea>, <checkbox>, <radioButton>, <list> and <separator> subelements.
* <swingDialog> task: Subelement <list> now has an attribute "visibleRowCount=..." to fix its vertical size.

===Version 1.1.1, 2015-09-23:===
* <swingDialog>: Label, Checkbox and RadioButton tags may now contain literal text, as an alternative to the "text=..." attribute. Particularly useful in connection with HTML label text and CDATA sections.

===Version 1.1.0, 2015-09-11:===
* <setAuthenticator>: The authenticator now returns "null" when no "<credentials>" matches (instead of "user=null, password=null").
* Added the "<ftp2>" task, which extends the "<ftp>" task with proxy capabilities.

===Version 1.0.18, 2015-05-05:===
* <swingDialog> / <textField>: Added the "label" attribute which makes it possible to have labels LEFT from a text field.
* <swingDialog> / <textField>: Added the "labelWidth" attribute to be able to align multiple labelled text fields vertically.

===Version 1.0.17, 2015-04-17:===
* <swingDialog>: Added the "<textArea>" subelement.

===Version 1.0.16, 2015-04-07:===
* <swingDialog>: Added the 'labels="..."' attribute so that the list can display text different from the 'values="..."'.

===Version 1.0.15, June 25 2014:===
* <urlConnection><jsonAsproperties>: Response was always decoded with charset 'ISO-8859-1' instead of the connection's charset (reponse header 'Content-Type').
* Added the '<tee>' filter reader.
* <forEach2>, <throughput>: Added 'currentQuantity="..."' attribute.
* <forEach2>, <throughput>: Report cumulated throughput iff previousQuantity is known.
* <setAuthenticator>: Shorten very long URLs when displayed in the authentication dialog.
* <urlConnection>: Added 'append="true"' attribute.

===Version 1.0.14, May 1 2014:===
* Moved the <log>, <logging> and <simpleLogging> tasks from 'de.unkrig.commons.util' to 'de.unkrig.antcontrib'.
* <logging>: Removed attribute 'parent="..."'; added attribute 'clearFilter="true"'.
* <simpleLogging>: Attribute 'debug="..."' no longer is boolean, but "FINE|FINER|FINEST".
* ANT-CONTRIB now uses 'de.unkrig.commons' - which is possible since the 'de.unkrig.commons' classes are renamed by JARJAR.
* Moved JSON-related classes from 'de.unkrig.antcontrib' to 'de.unkrig.commons.text.json'.
* Moved 'Duration', 'PointOfTime' and 'TimeInterval' from 'de.unkrig.antcontrib.util' to 'de.unkrig.commons.util.time'.

===Version 1.0.13, Apr 07 2014:===
* <forEach2>, <throughput>: Added automatic singularization of quantity unit.
* <forEach2>: Added substitution of '@{param}'.
* <throughput>: Removed redundant 'quantityUnit' in beforeMessage and afterMessage.
* <urlConnection>: Fixed the code for deleting partially written files (previously, half-READ files were deleted).
* Added resource collection '<resourceTransformer>'.
* <retry2>: Print locations when reporting nested task failure.
* <forEach2>: Added 'count="N"' attribute
* <forEach2>: Loop indefinitely (until FAIL or BREAK) if none of 'count', 'list' and Iterable are configured.
* <forEach2>: Added attribute 'quantityUnit="..."'.
* <throughput>: Eliminated some 'division by zero' problems (resulted in ugly 'NaN' percentages).

===Version 1.0.12, Mar 11 2014:===
* Added new resource collection '<literalResource>'.
* <forEach2>: Added 'message=...' and 'showEta=...' which enable a throughput analysis in the style of <throughput>.

===Version 1.0.11, Mar 06 2014:===
* <urlConnection> and <jsonAsProperties> tasks: Left-pad array indexes with zeros to make life easier for ANT (which has no numeric sorting feature).
* <throughput> task: Added the 'before message' feature.

===Version 1.0.10, Feb 24 2014:===
* Added the '<forEach2>' '<break> and '<continue>' tasks.
* Added the '<retry2>' task.
* 'Duration' no longer recognizes the 'mm:ss' pattern because the ambiguity with 'hh:mm' is extremely confusing. Use 'hh:mm:ss' instead.

===Version 1.0.9, Feb 23 2014:===
* <swingDialog>: Added the 'enabled=...' attribute to '<text>', '<checkbox>' and '<list>'.
* <resourceCollectionDelta>: Update the 'delta state' only when the RCD has been completely iterated. The latter is a strong indicator that the processing of the RCD was successful.
* Added the '<resourceNames>' resource collection.
* Added the '<throughput>' task.
* Added the '<every>', '<false>', '<successful>' and '<true>' conditions.

===Version 1.0.8, Jan 23 2014:===
* <swingDialog>: Added the 'defaultIndices=...' attribute.
* <swingDialog>: Added the 'focus=true' attribute for the subelements.

===Version 1.0.7, Dec 29 2013:===
* <urlConnection>: Added subelement '<formField name=... value=...>' to UrlElement, making HTML form submission easier.

===Version 1.0.6, Dec 13 2013:===
* Added the '<nslookup>' task.
* Added the '<follow>' task.
* Added the '<resourceCollectionDelta>' type.
* <urlConnection>: addConfiguredMultipartFormData: N different entries appeared as N time the FIRST entry.
* Added the '<progress>' FilterReader.
* <setAuthenticator>: Set the keyboard focus on the user name field.
* <urlConnection>: <filterchain> was ignored.

===Version 1.0.5, Nov 20 2013:===
* Removed the 'de.unkrig.ant-contrib.' prefix from the task and type names.
* Added the <jsonProperty> task which parses a JSON document into a set of properties, in analogy with the <xmlproperty> standard ANT task.
* Added the <setCookieHandler> task which enables cookie processing for HttpURLConnections, including the <urlConnection> task.
* Added the 'followRedirects2=true' attribute to the '<urlConnection>' task for enhanced HTTP redirection handling.
* Default behavior for '<urlConnection><input>' is now to copy the input to STDOUT.

===Version 1.0.4, Nov 11 2013:===
(No change log available.)

===Version 1.0.3, Oct 18 2013:===
(No change log available.)

===Version 1.0.2, Oct 17 2013:===
(No change log available.)

===Version 1.0.1, Jun 14 2013:===
(No change log available.)

===Version 1.0.0, May 30 2013:===
(No change log available.)

Ant-contrib.unkrig.de

2024-05-01T18:21:32Z

Aunkrig: Created page with "This project was renamed to "Antology" to get rid of the constant confusion with the (related, but otherwise independent) "[http://ant-contrib.sourceforge.net/ ant-contrib]" project on SOURCEFORGE. As a consequence, in all your ANT build scripts, you have to change <taskdef resource="de/unkrig/antcontrib/ant.xml" classpath="path/to/de.unkrig.ant-contrib.jar" /> to <taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-x.y.z-jar-with-depend..."

This project was renamed to "[[Antology]]" to get rid of the constant confusion with the (related, but otherwise independent) "[http://ant-contrib.sourceforge.net/ ant-contrib]" project on SOURCEFORGE.

As a consequence, in all your ANT build scripts, you have to change

<taskdef resource="de/unkrig/antcontrib/ant.xml" classpath="path/to/de.unkrig.ant-contrib.jar" />

to

<taskdef resource="de/unkrig/antology/ant.xml" classpath="path/to/antology-x.y.z-jar-with-dependencies.jar" />

. That's all, folks!

Antology

2024-05-01T18:20:29Z

Aunkrig: Created page with "<meta name="keywords" content="apache, ant, antlib, library, extension, tasks, types, filters"></meta> <meta name="description" content="A library for APACHE ANT that contributes many useful, resource collections, and other types"></meta> This library contributes useful tasks and types to [http://ant.apache.org APACHE ANT]. It integrates seamlessly with other libraries like [http://ant-contrib.sourceforge.net/ ant-contrib]. ANTOLOGY was formerly known as "Ant-contrib...."

File:Javawordcloud.png

2024-05-01T18:13:05Z

Aunkrig:

Unkrig.de

2024-05-01T18:10:45Z

Aunkrig:

 
<div align="center"><font size="+6"><b>Welcome to unkrig.de!</b></font><br><br><font color="#777">''Where the fine software grows''</font></div>
 

[[image:Javawordcloud.png|right]]

== Preamble ==

Hello out there!

I am a professional programmer, and when I have time I work on several cool open source projects. Find them useful, interesting, inspiring - or contribute! To contact me, send email to 'arno att unkrig dott de'.

Cheers, Arno

== Larger Projects ==

=== [https://janino-compiler.github.io/janino/ Janino] ===
: A super-small, super-fast Java™ compiler for embedded applications where you want to compile code on-the-fly into byte code which is executed in the running JVM.

=== [https://github.com/aunkrig/lfr LFR - Lightning-fast Regular Expressions for Java] ===
: A 99.9%-complete reimplementation of <code>java.util.regex</code> ("JUR") with better <code>match()</code> and <code>find()</code> performance.

=== [[Antology]] ===
: Some contributions to [http://ant.apache.org APACHE ANT], e.g. the <code><swingDialog></code> task which significantly enhances ANT's <code><input></code> task.

=== [[Zz.unkrig.de|ZZ Tools]] ===
: Enhanced versions of the widely known DIFF, FIND, GREP and PATCH command-line tools, which handle not only directories and files, but also archive and compressed files, and even nested archive and compressed files. They can even disassemble Java <code>.class</code> files on-the fly and operate on the disassembly.

=== [[Cs-contrib.unkrig.de|CheckStyle Contributions]] ===
: Additional checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS].

=== [[Commons.unkrig.de]] ===
: A versatile Java™ library, including a highly flexible HTTP and FTP server.

== Smaller Projects ==

=== [https://github.com/aunkrig/autoauth AUTOAUTH] ===

An HTTP proxy that handles proxy authentication.

=== [[Doclet|Doclets]] ===

Doclets are a way to re-use the JAVADOC tool to do other things than just generate Java API documentation. I wrote a few of them for different purposes:

===== [[ANT doclet|The ANT Doclet]] =====
: Generates JAVADOC-like HTML documentation for an ANTLIB, e.g. for [[Antology]] and the [[Zz.unkrig.de|ZZ tools]].

===== [[Cs-doclet|The CheckStyle Doclet]] =====
: Generates the metadata files for CheckStyle and eclipse-cs from 'doc tags' in the source code of your checks and filters.

===== [[JAVADOC doclet|The JAVADOC Doclet]] =====
: A re-implementation of the JAVADOC standard doclet, basically a reference to show how to use the "[[No-template|no-template]]" framework.

===== [[MAIN doclet|The MAIN Doclet]] =====
: Generates HTML documentation for a "main()" method - useful for command line tools with a set of command line options.

=== [[Html2txt|html2txt]] ===
: A Java tool to convert HTML documents into plain text.

=== [[JDisasm|jdisasm]] ===
: A disassembler for Java .class files.

=== [[No-template|no-template]] ===
: A super-small Java library for templating, i.e. generating text files (HTML, XML, whatever) from a "template" text file.

== Retired Projects ==

These projects are no longer maintained and are only of limited use, e.g. because they work only with old Java versions.

=== [[Loggifier.unkrig.de|Loggifier]] ===
: A tool for automatic injection of logging code into Java™ class files, making it unnecessary to mess up your code with hand-written logging.

=== [[Cvstools.unkrig.de|Eclipse plug-in for extended CVS possibilities]] ===

: An ECLIPSE plug-in that adds CVS functionality that is sometimes painfully missing from ECLIPSE's built-in CVS client.

=== [[Subclipse.unkrig.de|Subclipse enhancements Eclipse plug-in]] ===

: The often-missed <code><de.unkrig.subclipse.svn></code> ANT task that uses the SUBCLIPSE client of the running ECLIPSE workbench.