com.github.aliteralmind.codelet.type

Class SourceAndOutTemplate

java.lang.Object

com.github.xbn.io.SimpleDebuggable

com.github.aliteralmind.codelet.CodeletTemplateBase

com.github.aliteralmind.codelet.type.SourceAndOutTemplate

All Implemented Interfaces:

Debuggable, GetDebugApbl_Fieldable

public class SourceAndOutTemplate
extends CodeletTemplateBase

The text into which {@.codelet.and.out} output (the example-code's console output) is placed.

Codelet: {@.codelet.and.out}: Template: Gap names

The only required gaps are "body_source_code" and "body_console_output", which are where the fully-processed source and output are placed.

In addition to any user-extra gaps {@.codelet.and.out} template provides for the same "default" optional gaps as made available in both SourceCodeTemplate and SourceAndOutTemplate.

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	GAP_BODY_CONSOLE_OUTPUT The gap name for the fully processed console output, which is one of two gaps required to exist in the template--equal to "body_console_output".
static String	GAP_BODY_SOURCE_CODE The gap name for the fully processed source-code, which is one of two gaps required to exist in the template--equal to "body_source_code".

Constructor Summary

Constructors

Constructor and Description
SourceAndOutTemplate(FeatherTemplate template, String tmpl_path, UserExtraGapGetter userExtra_getter) Create the first instance.
SourceAndOutTemplate(SourceAndOutTemplate to_copy, Appendable debugDest_ifNonNull)
SourceAndOutTemplate(SourceAndOutTemplate to_copy, FeatherTemplate template, String tmpl_path) Create the second or subsequent instance.

Method Summary

Methods

Modifier and Type	Method and Description
SourceAndOutTemplate	fillConsoleOutputBody(String body_text) Fill the fully-processed console-output body gap.
SourceAndOutTemplate	fillSourceCodeBody(String body_text) Fill the fully-processed source-code body gap.
SourceAndOutTemplate	getObjectCopy(Appendable debugDest_ifNonNull) Duplicate this template.
static SourceAndOutTemplate	newFromPathAndUserExtraGaps(String path, String path_name, UserExtraGapGetter userExtra_getter)
static FeatherTemplate	newTemplateFromPath(String path, String path_name)

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

addCustomGaps, fillBodyGap, getGapCount, 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

GAP_BODY_SOURCE_CODE

public static final String GAP_BODY_SOURCE_CODE

The gap name for the fully processed source-code, which is one of two gaps required to exist in the template--equal to "body_source_code".

See Also:

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

GAP_BODY_CONSOLE_OUTPUT

public static final String GAP_BODY_CONSOLE_OUTPUT

The gap name for the fully processed console output, which is one of two gaps required to exist in the template--equal to "body_console_output".

See Also:

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

Constructor Detail

SourceAndOutTemplate

public SourceAndOutTemplate(FeatherTemplate template,
                    String tmpl_path,
                    UserExtraGapGetter userExtra_getter)

Create the first instance.

Equal to

super(CodeletType.SOURCE_AND_OUT, template, tmpl_path
   new String[]{GAP_BODY_SOURCE_CODE, GAP_BODY_CONSOLE_OUTPUT},
   new CodeletGap[] {
      ConsoleOutTemplate.GAP_COMMAND_LINE_PARAMS.GAP_COMMAND_LINE_PARAMS,
      SourceCodeTemplate.GAP_FQ_CLASS_NAME,
      SourceCodeTemplate.GAP_FQ_CLASS_NAME_DIR,
      SourceCodeTemplate.GAP_FQ_CLASS_NAME_URL,
      SourceCodeTemplate.GAP_JAVADOC_URL,
      SourceCodeTemplate.GAP_PACKAGE,
      SourceCodeTemplate.GAP_PACKAGE_DIR,
      SourceCodeTemplate.GAP_PACKAGE_URL,
      SourceCodeTemplate.GAP_SIMPLE_CLASS_NAME,
      SourceCodeTemplate.GAP_SOURCE_URL,
      SourceCodeTemplate.GAP_SRC_BASE_DIR,
      SourceCodeTemplate.GAP_SRC_PATH},
   userExtra_getter)

See Also:

SourceAndOutTemplate(SourceAndOutTemplate, FeatherTemplate, String)

SourceAndOutTemplate

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

Create the second or subsequent instance.

Equal to

super(to_copy, template, tmpl_path)

See Also:

SourceAndOutTemplate(FeatherTemplate, String, UserExtraGapGetter)

SourceAndOutTemplate

public SourceAndOutTemplate(SourceAndOutTemplate to_copy,
                    Appendable debugDest_ifNonNull)

Method Detail

fillSourceCodeBody

public final SourceAndOutTemplate fillSourceCodeBody(String body_text)

Fill the fully-processed source-code body gap.

Equal to

fillBodyGap(GAP_BODY_SOURCE_CODE, body_text)*

See Also:

fillConsoleOutputBody(String)

fillConsoleOutputBody

public final SourceAndOutTemplate fillConsoleOutputBody(String body_text)

Fill the fully-processed console-output body gap.

Equal to

fillBodyGap*(GAP_BODY_CONSOLE_OUTPUT, body_text)

See Also:

fillSourceCodeBody(String)

getObjectCopy

public SourceAndOutTemplate getObjectCopy(Appendable debugDest_ifNonNull)

Duplicate this template.

Specified by:

getObjectCopy in class CodeletTemplateBase

Returns:

(new SourceAndOutTemplate(this, debugDest_ifNonNull))

newFromPathAndUserExtraGaps

public static final SourceAndOutTemplate newFromPathAndUserExtraGaps(String path,
                                               String path_name,
                                               UserExtraGapGetter userExtra_getter)

newTemplateFromPath

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