com.github.aliteralmind.codelet

Class CodeletGap

java.lang.Object

com.github.xbn.keyed.SimpleKeyed<String>

com.github.xbn.keyed.SimpleNamed

com.github.aliteralmind.codelet.CodeletGap

All Implemented Interfaces:

Keyed<String>, Named

public abstract class CodeletGap
extends SimpleNamed

A single gap in a Codelet template, including a function that fills it based on the Codelet instance and global configuration.

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

See Also:

type.SourceCodeTemplate, type.ConsoleOutTemplate, type.SourceAndOutTemplate, type.FileTextTemplate, UserExtraGapGetter

Constructor Summary

Constructors

Constructor and Description
CodeletGap(String name) Create a new instance with a name.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getFillText(CodeletInstance instance) The output string that replaces the gap.

Methods inherited from class com.github.xbn.keyed.SimpleNamed

ciBadNameInCnstr, getName

Methods inherited from class com.github.xbn.keyed.SimpleKeyed

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeletGap

public CodeletGap(String name)

Create a new instance with a name.

Equal to super(name)

Parameters:

name - May not be null or empty, and must contain only letters, digits, and underscores. Get with getName()*.

Method Detail

getFillText

public abstract String getFillText(CodeletInstance instance)

The output string that replaces the gap.

Parameters:

instance - The codelet instance. May not be null. When creating a ...custom gap... you do not need to check (or try-catch) for null-ness.

Returns:

A non-null string.