dev.jeka.core.api.file

Class JkResourceProcessor

java.lang.Object

dev.jeka.core.api.file.JkResourceProcessor

public final class JkResourceProcessor
extends java.lang.Object

This processor basically copies some resource files to a target folder (generally the class folder). It can also proceed to token replacement, i.e, replacing strings between ${ and } by a specified values.
The processor is constructed from a JkPathTreeSet and for each of them, we can associate a token map for interpolation.

Method Summary

Modifier and Type	Method and Description
JkResourceProcessor	addInterpolation(java.lang.String... keyValues)
JkResourceProcessor	addInterpolator(java.util.Map<java.lang.String,java.lang.String> keyValues)
JkResourceProcessor	addInterpolator(java.nio.file.PathMatcher pathMatcher, java.util.Map<java.lang.String,java.lang.String> keyValues)
JkResourceProcessor	addInterpolator(java.lang.String acceptPattern, java.util.Map<java.lang.String,java.lang.String> keyValues)
JkResourceProcessor	addInterpolator(java.lang.String acceptPattern, java.lang.String... keyValues)
JkResourceProcessor	addInterpolators(java.lang.Iterable<dev.jeka.core.api.file.JkResourceProcessor.JkInterpolator> interpolators) Adds specified interpolators to this resource processor.
JkResourceProcessor	addInterpolators(dev.jeka.core.api.file.JkResourceProcessor.JkInterpolator... interpolators)
JkResourceProcessor	apply(java.util.function.Consumer<JkResourceProcessor> consumer) Applies the specified consumer to this object.
void	generate(JkPathTreeSet resourceTrees, java.nio.file.Path outputDir) Actually processes the resources, meaning copies the getResources to the specified output directory along replacing specified tokens.
void	generate(java.nio.file.Path resourceDir, java.nio.file.Path outputDir)
java.nio.charset.Charset	getInterpolationCharset() Returns the charset used for interpolation
static JkResourceProcessor	of() Creates an empty resource processor
JkResourceProcessor	setInterpolationCharset(java.nio.charset.Charset interpolationCharset) Set the charset used for interpolation.

Methods inherited from class java.lang.Object

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

Method Detail

apply

public JkResourceProcessor apply(java.util.function.Consumer<JkResourceProcessor> consumer)

Applies the specified consumer to this object.

of

public static JkResourceProcessor of()

Creates an empty resource processor

addInterpolators

public JkResourceProcessor addInterpolators(java.lang.Iterable<dev.jeka.core.api.file.JkResourceProcessor.JkInterpolator> interpolators)

Adds specified interpolators to this resource processor.

addInterpolators

public JkResourceProcessor addInterpolators(dev.jeka.core.api.file.JkResourceProcessor.JkInterpolator... interpolators)

See Also:

addInterpolators(Iterable)

addInterpolator

public JkResourceProcessor addInterpolator(java.nio.file.PathMatcher pathMatcher,
                                           java.util.Map<java.lang.String,java.lang.String> keyValues)

See Also:

addInterpolators(Iterable)

addInterpolator

public JkResourceProcessor addInterpolator(java.lang.String acceptPattern,
                                           java.util.Map<java.lang.String,java.lang.String> keyValues)

See Also:

addInterpolators(Iterable)

addInterpolator

public JkResourceProcessor addInterpolator(java.util.Map<java.lang.String,java.lang.String> keyValues)

See Also:

JkPathMatcher##addInterpolator(PathMatcher, Map)

addInterpolator

public JkResourceProcessor addInterpolator(java.lang.String acceptPattern,
                                           java.lang.String... keyValues)

See Also:

addInterpolators(Iterable)

addInterpolation

public JkResourceProcessor addInterpolation(java.lang.String... keyValues)

Parameters:

keyValues - a sequence of key-value as key1, value1, ke2, value2

See Also:

addInterpolators(Iterable)

getInterpolationCharset

public java.nio.charset.Charset getInterpolationCharset()

Returns the charset used for interpolation

setInterpolationCharset

public JkResourceProcessor setInterpolationCharset(java.nio.charset.Charset interpolationCharset)

Set the charset used for interpolation. This charset is not used if no interpolation occurs.

generate

public void generate(java.nio.file.Path resourceDir,
                     java.nio.file.Path outputDir)

See Also:

generate(Path, Path)

generate

public void generate(JkPathTreeSet resourceTrees,
                     java.nio.file.Path outputDir)

Actually processes the resources, meaning copies the getResources to the specified output directory along replacing specified tokens.