com.github.aliteralmind.codelet.type

Class ConsoleOutTemplate

java.lang.Object

com.github.xbn.io.SimpleDebuggable

com.github.aliteralmind.codelet.CodeletTemplateBase

com.github.aliteralmind.codelet.type.OnlyOneBodyGapTemplateBase

com.github.aliteralmind.codelet.type.ConsoleOutTemplate

All Implemented Interfaces:

Debuggable, GetDebugApbl_Fieldable

public class ConsoleOutTemplate
extends OnlyOneBodyGapTemplateBase

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

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

The only required gap is "body", which is where the fully-processed source-code is placed.

In addition to any user-extra gaps, the {@.codelet} template also provides for the following "default" optional gaps:

Name	Description
command_line_params	Parameters as passed to the example code's main function.
simple_class_name*	The example code's non-fully-qualified class name.
fq_class_name*	The example code's fully-qualified class name.
package*	The example code's package name.

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 CodeletGap	GAP_COMMAND_LINE_PARAMS Parameters as passed to the example code's main function--Name is "command_line_params".

Fields inherited from class com.github.aliteralmind.codelet.type.OnlyOneBodyGapTemplateBase

BODY_GAP_NAME

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ConsoleOutTemplate	fillBody(String fully_processed)
ConsoleOutTemplate	getObjectCopy(Appendable debugDest_ifNonNull) Duplicate this template.
static ConsoleOutTemplate	newFromPathAndUserExtraGaps(String path, String path_name, UserExtraGapGetter userExtra_getter)

Methods inherited from class com.github.aliteralmind.codelet.type.OnlyOneBodyGapTemplateBase

fillBodyGap, newTemplateFromPath

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_COMMAND_LINE_PARAMS

public static final CodeletGap GAP_COMMAND_LINE_PARAMS

Parameters as passed to the example code's main function--Name is "command_line_params".

Gap is filled with

................

See Also:

Constructor Detail

ConsoleOutTemplate

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

Create the first instance.

Equal to

super(CodeletType.SOURCE_CODE, template, tmpl_path,
   new CodeletGap[] {
      SourceCodeTemplate.GAP_PACKAGE,
      SourceCodeTemplate.GAP_SIMPLE_CLASS_NAME,
      SourceCodeTemplate.GAP_FQ_CLASS_NAME,
      GAP_COMMAND_LINE_PARAMS},
   userExtra_getter)

See Also:

ConsoleOutTemplate(ConsoleOutTemplate, FeatherTemplate, String)

ConsoleOutTemplate

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

Create the second or subsequent instance.

Equal to

super(to_copy, template, tmpl_path)

See Also:

ConsoleOutTemplate(FeatherTemplate, String, UserExtraGapGetter)

ConsoleOutTemplate

public ConsoleOutTemplate(ConsoleOutTemplate to_copy,
                  Appendable debugDest_ifNonNull)

Method Detail

fillBody

public ConsoleOutTemplate fillBody(String fully_processed)

getObjectCopy

public ConsoleOutTemplate getObjectCopy(Appendable debugDest_ifNonNull)

Duplicate this template.

Specified by:

getObjectCopy in class CodeletTemplateBase

Returns:

(new ConsoleOutTemplate(this, debugDest_ifNonNull))

newFromPathAndUserExtraGaps

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