com.github.aliteralmind.codelet

Class TagletProcessor

java.lang.Object

com.github.aliteralmind.codelet.TagletProcessor

public class TagletProcessor
extends Object

Generates the output for a single Codelet of any type. This class--and this entire package--knows nothing of com.sun. This is the middleman between com.sun and TagletOfTypeProcessor.

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

Constructor Summary

Constructors

Constructor and Description
TagletProcessor(CodeletInstance instance) Create a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	get() Get the taglet's already-rendered output text.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagletProcessor

public TagletProcessor(CodeletInstance instance)
                throws ClassNotFoundException,
                       NoSuchMethodException,
                       NoSuchFileException,
                       AccessDeniedException,
                       InterruptedException

Create a new instance. Once constructed, the taglet's output may be obtained with get().

This

1. If this is the first encountered codelet-taglet, this loads all configuration.
2. If the enclosing file is black-listed, get() is set to instance.getFullOriginalTaglet(), and this exits.
3. Otherwise, this constructs a new processor, based on the instance's type:
   • type.SourceCodeProcessor
   • type.ConsoleOutProcessor
   • FileTextProcessor
   • SourceAndOutProcessor
   and sets get() to its fully-customized text.

Parameters:

instance - May not be null.

Throws:

IllegalStateException - If instance is of an unknown type (this is protection against a new type being added).

ClassNotFoundException - Depending on the tag being used, and its format, if:

• The example class specified in the taglet does not exist (according to Class.forName)
• The explicitly specified customizer class does not exist.

NoSuchMethodException - If the customizer function does not exist, either in the explicitly specified or default classes, or does not meet its requirements.

NoSuchFileException - If the source-code or plain-text file does not exist.

AccessDeniedException - If the file exists, but cannot be read.

InterruptedException

Method Detail

get

public String get()

Get the taglet's already-rendered output text.

Returns:

[the-processor].getFullyCustomizedOutput()

See Also:

TagletProcessor(CodeletInstance)