com.github.aliteralmind.codelet.type

Class FileTextProcessor

java.lang.Object

com.github.aliteralmind.codelet.TagletOfTypeProcessor<FileTextTemplate>

com.github.aliteralmind.codelet.type.FileTextProcessor

public class FileTextProcessor
extends TagletOfTypeProcessor<FileTextTemplate>

Reads a {@.file.textlet} taglet and outputs its replacement text.

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 inherited from class com.github.aliteralmind.codelet.TagletOfTypeProcessor

DEFAULT_CUSTOMIZER_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
FileTextProcessor(CodeletInstance instance) Create a new instance from an CodeletInstance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getStringSigForFileText() Get the string signature for a {@.file.textlet} taglets only.

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

crashIfClassOrFileCannotUseCustomizer, getClassOrFilePortion, getCustomCustomizationInstructions, getCustomizationInstructions, getCustomizerPortion, getCustomizerSigFromString, getExampleCodeStringSig, getFullyCustomizedOutput, getInstance, getInstructionsFromSig, getSig2PrnsApnddForNameOrPostfix, getSourceCodeLineIterator, getStringSignature, getTemplateFromInstructionsOverrideOrDefault, newInstructionsForDefaults, setFullyProcessedOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

FileTextProcessor

public FileTextProcessor(CodeletInstance instance)
                  throws ClassNotFoundException,
                         NoSuchMethodException,
                         NoSuchFileException,
                         AccessDeniedException

Create a new instance from an CodeletInstance.

Equal to super(CodeletType.FILE_TEXT, instance)

Throws:

ClassNotFoundException

NoSuchMethodException

NoSuchFileException

AccessDeniedException

Method Detail

getStringSigForFileText

public String getStringSigForFileText()

Get the string signature for a {@.file.textlet} taglets only. Except where noted, this does not validate the taglet text or the returned signature.

This follows the same steps as getStringSignature, except

• The customizer portion of the taglet, when provided, must contain either an underscore ('_') postfix or the processor's full function name.
• The default function name prefix is "getFileTextConfig_"

Throws:

CodeletFormatException - If no function name or underscore-postfix is provided.