Module uk.autores

Package uk.autores.handling

Class GenerateStringsFromText

java.lang.Object

uk.autores.handling.GenerateStringsFromText

All Implemented Interfaces:

Handler

public final class GenerateStringsFromText
extends Object
implements Handler

Handler that generates classes that returns file contents as Strings.

For each resource, generates a class with a name derived from the resource name using Namer.simplifyResourceName(String) and Namer.nameType(String). The class will have a static method called text that returns the resource as a String.

Resource files over Integer.MAX_VALUE in size will result in an error during compilation.

The CharsetDecoder is configured with CodingErrorAction.REPORT on malformed input or unmappable characters which will result in build failures.

Constructor Summary

Constructors

Constructor	Description
GenerateStringsFromText()	Ctor

Method Summary

Modifier and Type	Method	Description
Set<ConfigDef>	config()	All configuration is optional.
void	handle(Context context)	Handles the context resources.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.autores.handling.Handler

validConfig

Constructor Detail

GenerateStringsFromText

public GenerateStringsFromText()

Ctor

Method Detail

config

public Set<ConfigDef> config()

All configuration is optional.

"UTF-8" is assumed if "encoding" is not set and this is the recommended encoding.

Use "visibility" to make the generated classes public.

Strategy:

• CfgStrategy.AUTO: CfgStrategy.INLINE for files up to 65535B when encoded as modified UTF-8 - the limit for a String constant; CfgStrategy.LAZY otherwise
• CfgStrategy.INLINE: files become String literals
• CfgStrategy.CONST: alias for CfgStrategy.INLINE
• CfgStrategy.LAZY: files are loaded using the ClassLoader

The lazy strategy requires that the resource file be provided at runtime. The inline strategy will break down as the resource file approaches 500MB due to class file limitations.

Specified by:

config in interface Handler

Returns:

visibility; encoding; strategy

See Also:

CfgVisibility, CfgEncoding, CfgStrategy

handle

public void handle(Context context)
            throws Exception

Description copied from interface: Handler

Handles the context resources.

Specified by:

handle in interface Handler

Parameters:

context - processing context

Throws:

Exception - any exception

See Also:

Context.resources()