com.github.aliteralmind.codelet.alter

Interface DefaultAlterGetter

All Known Implementing Classes:

DefaultDefaultAlterGetter

public interface DefaultAlterGetter

Defines alterers used by all pre-built customizers, which are also accessible in custom customizers. The fully-qualified class name of your implementation is specified in the default_alterers_class_name configuration variable.

Implementation requirements:

• All functions must return a non-null map, where no key is null or empty, and no value is null.
• There must be a no-parameter constructor.

Alterations are made in the same order as they are returned by the iterator. When used by pre-built customizers, these default alterations take place after all others (they are added to the end of the alter-array).

It is strongly recommended that at least the escape html alterer be returned by all getFor functions. This is in fact the only alterer returned by all functions in DefaultDefaultAlterGetter.

Since:

0.1.0

Author:

Copyright (C) 2014, Jeff Epstein (aliteralmind __DASH__ github __AT__ yahoo __DOT__ com), dual-licensed under the LGPL (version 3.0 or later) or the ASL (version 2.0). See source code for details. http://codelet.aliteralmind.com, https://github.com/aliteralmind/codelet

Method Summary

Methods

Modifier and Type	Method and Description
LinkedHashMap<String,TextLineAlterer>	getForCodeletDotOut() Default alterers for {@.codelet.out} taglets, when configured.
LinkedHashMap<String,TextLineAlterer>	getForFileTextlet() Default alterers for {@.file.textlet} taglets, when configured.
LinkedHashMap<String,TextLineAlterer>	getForSourceCodelet() Default alterers for (source-code) {@.codelet} taglets, when configured.

Method Detail

getForSourceCodelet

LinkedHashMap<String,TextLineAlterer> getForSourceCodelet()

Default alterers for (source-code) {@.codelet} taglets, when configured.

This is also used by {@.codelet.and.out} taglets.

Returns:

A non-null map, where no key is null or empty, and no value is null. Each value should be unique.

See Also:

getForCodeletDotOut(), getForFileTextlet()

getForCodeletDotOut

LinkedHashMap<String,TextLineAlterer> getForCodeletDotOut()

Default alterers for {@.codelet.out} taglets, when configured.

This is also used by {@.codelet.and.out} taglets.

Returns:

A non-null map, where no key is null or empty, and no value is null. Each value should be unique.

See Also:

getForSourceCodelet()

getForFileTextlet

LinkedHashMap<String,TextLineAlterer> getForFileTextlet()

Default alterers for {@.file.textlet} taglets, when configured.

Returns:

A non-null map, where no key is null or empty, and no value is null. Each value should be unique.

See Also:

getForSourceCodelet()