Class FilterHelpAppendable

java.lang.Object
org.apache.commons.cli.help.FilterHelpAppendable
All Implemented Interfaces:
Appendable, HelpAppendable
Direct Known Subclasses:
TextHelpAppendable

public abstract class FilterHelpAppendable extends Object implements HelpAppendable
An abstract implementation of HelpAppendable that writes output to an Appendable instance.

This class is the superclass of all classes that filter help appendables. These appendable sit on top of an existing appendable (the underlying appendable) which it uses as its basic sink of data, but possibly transforming the data along the way or providing additional functionality.

The class FilterHelpAppendable itself simply overrides all methods of HelpAppendable with versions that pass all requests to the underlying appendable. Subclasses of FilterHelpAppendable may further override some of these methods as well as provide additional methods and fields.

Implementation Note: This class is similar to FilterOutputStream in relation to OutputStream. We could further split FilterHelpAppendable into a FilterAppendable but that seems like YAGNI.

Since:
1.10.0