com.github.aliteralmind.codelet

Class CodeletTemplateBase

java.lang.Object

com.github.xbn.io.SimpleDebuggable

com.github.aliteralmind.codelet.CodeletTemplateBase

All Implemented Interfaces:

Debuggable, GetDebugApbl_Fieldable

Direct Known Subclasses:

OnlyOneBodyGapTemplateBase, SourceAndOutTemplate

public abstract class CodeletTemplateBase
extends SimpleDebuggable

What the fully-processed output (source-code, console output, or plain-file text) is put into--The rendered template is what actually replaces the codelet-taglet.

Codelet: Templates: Overview

Codelet templates have one or two required "body" gaps, where the fully-processed text (source-code, console output, or plain-file text) is placed. The {@codelet.and.out} template has two body gaps, the rest have one. Each template type defines "optional-default" gaps, which you may place in your templates at your discretion. "Extra user-created" gaps are permitted if explicitely configured.

All gaps, in all Codelet templates (including user-created), are automatically filled.

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

Constructor Summary

Constructors

Constructor and Description
CodeletTemplateBase(CodeletTemplateBase to_copy, Appendable debugDest_ifNonNull) Create a new instance as a duplicate of another.
CodeletTemplateBase(CodeletTemplateBase to_copy, FeatherTemplate template, String tmpl_path) Create the second or subsequent instance.
CodeletTemplateBase(CodeletType type, FeatherTemplate template, String tmpl_path, String[] required_bodyGapNames, CodeletGap[] optional_defaultGaps, UserExtraGapGetter userExtra_gapGetter) Create the first instance only.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addCustomGaps(Map<String,CodeletGap> optionalDefault_gapMap, CodeletGap[] gap_array) Add custom gaps to the template.
void	fillBodyGap(String body_gapName, String body_text) Fill a body gap.
int	getGapCount() The number of gaps actually in the template.
abstract CodeletTemplateBase	getObjectCopy(Appendable debugDest_ifNonNull)
String	getPath()
String	getRendered(CodeletInstance instance) ReplacedInEachInput all default-optional and user-extra gaps with their values, resets the template, and returns its fully-rendered text--This is what actually replaces the codelet-taglet.
protected FeatherTemplate	getTemplate() The template.
CodeletType	getType() The type of this template.
static Map<String,CodeletGap>	newGapMapFromArray(CodeletGap[] gap_array) Create a new map of all gap objects.
static FeatherTemplate	newTemplateFromPath(String path, String path_varName, String... required_gaps) Read in and parse a template given its path.
void	setDebug(Appendable destination, boolean is_on)
void	setDebugOn(boolean is_on)

Methods inherited from class com.github.xbn.io.SimpleDebuggable

appendToString, debug, debugln, getDebugApbl, getDebugAptr, getObjectCopy, isDebugOn, onIfNonNull, toString, zsetDebugDB, zsetDebugOnDB

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeletTemplateBase

public CodeletTemplateBase(CodeletType type,
                   FeatherTemplate template,
                   String tmpl_path,
                   String[] required_bodyGapNames,
                   CodeletGap[] optional_defaultGaps,
                   UserExtraGapGetter userExtra_gapGetter)

Create the first instance only. To avoid circular dependencies, this class cannot have any references to CodeletBaseConfig.

Parameters:

type - May not be null. Get with getType().

template - May not be null, must be resettable, and must contain all body gaps, and no gaps that are not either optional-default or user-extra. This is duplicated (defensively copied). Get with getTemplate().

tmpl_path - The full path to the template file. May not be null or empty. Get with getPath()

required_bodyGapNames - The one or two required body-gap names.

optional_defaultGaps - The optional-default gaps for the codelet type. May not be null or contain null elements, and all gap names must be unique.

userExtra_gapGetter - Extra user-configured gaps. If null, there are no extra. Otherwise, the gaps its function (of type type) returns may not be null or contain null elements, and all gap names must be unique and not equal to the body gaps or those in optional_defaultGaps.

Throws:

IncorrectGapsException - If

• The length of required_bodyGapNames is invalid
• The user-extra gaps contain a body or optional-default gap
• The template is missing a body gap or contains any not in either the optional-defaults or user-extra

IllegalArgumentException - If the userExtra_gapGetter function of type type returns null.

See Also:

CodeletTemplateBase(CodeletTemplateBase, FeatherTemplate, String), CodeletTemplateBase(CodeletTemplateBase, Appendable)

CodeletTemplateBase

public CodeletTemplateBase(CodeletTemplateBase to_copy,
                   FeatherTemplate template,
                   String tmpl_path)

Create the second or subsequent instance.

Automated named debuggers

zzCodeletTemplateBase.templateparseandfill: FeatherTemplate.constructor

Parameters:

to_copy - May not be null.

template - May not be null, must have all body gaps, and may not have any gaps that are not either optional-default or user-extra. This is duplicated (defensively copied). Get with getTemplate().

See Also:

CodeletTemplateBase(CodeletType, FeatherTemplate, String, String[], CodeletGap[], UserExtraGapGetter), CodeletTemplateBase(CodeletTemplateBase, Appendable)

CodeletTemplateBase

public CodeletTemplateBase(CodeletTemplateBase to_copy,
                   Appendable debugDest_ifNonNull)

Create a new instance as a duplicate of another.

This calls

1. this(to_copy, to_copy.getTemplate(), to_copy.getPath())
2. onIfNonNull(debugDest_ifNonNull)

Method Detail

getType

public CodeletType getType()

The type of this template.

See Also:

CodeletTemplateBase(CodeletType, FeatherTemplate, String, String[], CodeletGap[], UserExtraGapGetter)

fillBodyGap

public void fillBodyGap(String body_gapName,
               String body_text)

Fill a body gap.

Equal to

getTemplate().fill(body_gapName, fill_with)

Parameters:

body_gapName - The body gap name. Must not have already been filled.

body_text - May not be null or empty.

getRendered

public String getRendered(CodeletInstance instance)

ReplacedInEachInput all default-optional and user-extra gaps with their values, resets the template, and returns its fully-rendered text--This is what actually replaces the codelet-taglet.

Parameters:

instance - May not be null.

Throws:

IllegalArgumentException - If any gaps are already filled, or if the com.github.aliteralmind.codelet.CodeletGap#getFillText(CodeletInstance) fill text is null or empty.

See Also:

fillBodyGap(String, String)

getGapCount

public int getGapCount()

The number of gaps actually in the template.

Returns:

getTemplate().getGapMap().size()

getTemplate

protected FeatherTemplate getTemplate()

The template.

See Also:

getGapCount(), CodeletTemplateBase(ct,ft,s,s[],cg[],uxgg)

getPath

public String getPath()

getObjectCopy

public abstract CodeletTemplateBase getObjectCopy(Appendable debugDest_ifNonNull)

newGapMapFromArray

public static final Map<String,CodeletGap> newGapMapFromArray(CodeletGap[] gap_array)

Create a new map of all gap objects.

Parameters:

gap_array - May not be null or contain null elements, and all gap names must be unique.

Throws:

IllegalArgumentException - If a gap name is used more than once.

See Also:

addCustomGaps(Map, CodeletGap[])

addCustomGaps

public static final void addCustomGaps(Map<String,CodeletGap> optionalDefault_gapMap,
                 CodeletGap[] gap_array)

Add custom gaps to the template.

Parameters:

optionalDefault_gapMap - May not be null, and must contain only the ...default gaps....

gap_array - May not be null or contain null elements, and all gap names must be unique and not contain any in optionalDefault_gapMap.

Throws:

IllegalArgumentException - If gap_array contains a duplicate or default gap name (or they've already been added to the template!).

newTemplateFromPath

public static final FeatherTemplate newTemplateFromPath(String path,
                                  String path_varName,
                                  String... required_gaps)

Read in and parse a template given its path.

Automated named debuggers

zzCodeletTemplateBase.newTemplateFromPath.

• loading: "Loading template from [path]..."
• templateparseandfill: FeatherTemplate.constructor

See Also:

SourceCodeTemplate#newFromPathAndUserExtraGaps, SourceAndOutTemplate#newFromPathAndUserExtraGaps, ConsoleOutTemplate#newFromPathAndUserExtraGaps, FileTextTemplate#newFromPathAndUserExtraGaps

setDebug

public void setDebug(Appendable destination,
            boolean is_on)

Specified by:

setDebug in interface Debuggable

Overrides:

setDebug in class SimpleDebuggable

setDebugOn

public void setDebugOn(boolean is_on)

Specified by:

setDebugOn in interface Debuggable

Overrides:

setDebugOn in class SimpleDebuggable