com.github.aliteralmind.codelet.type

Class OnlyOneBodyGapTemplateBase

java.lang.Object

com.github.xbn.io.SimpleDebuggable

com.github.aliteralmind.codelet.CodeletTemplateBase

com.github.aliteralmind.codelet.type.OnlyOneBodyGapTemplateBase

All Implemented Interfaces:

Debuggable, GetDebugApbl_Fieldable

Direct Known Subclasses:

ConsoleOutTemplate, FileTextTemplate, SourceCodeTemplate

public abstract class OnlyOneBodyGapTemplateBase
extends CodeletTemplateBase

For all templates but {@.codelet.and.out}.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	BODY_GAP_NAME The gap name for the fully processed source-code, which is the only gap required to exist in the template--equal to "body".

Constructor Summary

Constructors

Constructor and Description
OnlyOneBodyGapTemplateBase(CodeletType type, FeatherTemplate template, String tmpl_path, CodeletGap[] optional_defaultGaps, UserExtraGapGetter userExtra_getter) Create the first instance.
OnlyOneBodyGapTemplateBase(OnlyOneBodyGapTemplateBase to_copy, Appendable debugDest_ifNonNull)
OnlyOneBodyGapTemplateBase(OnlyOneBodyGapTemplateBase to_copy, FeatherTemplate template, String tmpl_path) Create the second or subsequent instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	fillBodyGap(String body_text) Fill the fully-processed text into the body gap.
static FeatherTemplate	newTemplateFromPath(String path, String path_name)

Methods inherited from class com.github.aliteralmind.codelet.CodeletTemplateBase

addCustomGaps, fillBodyGap, getGapCount, getObjectCopy, getPath, getRendered, getTemplate, getType, newGapMapFromArray, newTemplateFromPath, setDebug, setDebugOn

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

Field Detail

BODY_GAP_NAME

public static final String BODY_GAP_NAME

The gap name for the fully processed source-code, which is the only gap required to exist in the template--equal to "body".

See Also:

, CodeletTemplateBase.fillBodyGap(String, String), Constant Field Values

Constructor Detail

OnlyOneBodyGapTemplateBase

public OnlyOneBodyGapTemplateBase(CodeletType type,
                          FeatherTemplate template,
                          String tmpl_path,
                          CodeletGap[] optional_defaultGaps,
                          UserExtraGapGetter userExtra_getter)

Create the first instance.

Equal to

super(type, template, tmpl_path, new String[]{BODY_GAP_NAME}, optional_defaultGaps, userExtra_getter)

See Also:

OnlyOneBodyGapTemplateBase(OnlyOneBodyGapTemplateBase, FeatherTemplate, String)

OnlyOneBodyGapTemplateBase

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

Create the second or subsequent instance.

Equal to

super(to_copy, template, tmpl_path)

See Also:

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

OnlyOneBodyGapTemplateBase

public OnlyOneBodyGapTemplateBase(OnlyOneBodyGapTemplateBase to_copy,
                          Appendable debugDest_ifNonNull)

Method Detail

fillBodyGap

public final void fillBodyGap(String body_text)

Fill the fully-processed text into the body gap.

Equal to

fillBodyGap*(BODY_GAP_NAME, body_text)

newTemplateFromPath

public static final FeatherTemplate newTemplateFromPath(String path,
                                  String path_name)