TagletTextUtil (Codelet)

java.lang.Object
- com.github.aliteralmind.codelet.TagletTextUtil

```
public class TagletTextUtil
extends Object
```
Extract and transform elements from the taglet 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

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`getExampleClassFQName(CodeletInstance instance)` The example code's fully-qualified class name.
`static String`	`getExampleClassOrFilePortionFromTagletText(CodeletInstance instance)` The example-class or plain-text-file portion of the taglet text.
`static String`	`getExampleCommandLineParams(CodeletInstance instance)` The example code's command-line parameters, as used by `{@.codelet.out}` and `{@.codelet.and.out}` taglets.
`static String`	`getExamplePackageName(CodeletInstance instance)` Get the example code's package name.
`static String`	`getExampleSimpleClassName(CodeletInstance instance)` Get the example code's non-fully-qualified class name.
`static String`	`getFileNameWithExtension(CodeletInstance instance)` The plain-text file name, including its dot-extension (such as `".txt"`), if any.
`static String`	`getFileNameWithoutExtension(CodeletInstance instance)` The plain-text file name, excluding its dot-extension (such as `".txt"`).
`static String`	`getFilePath(CodeletInstance instance)` The full path to the plain-text file.
`static String`	`getJavaDocExampleUrl(CodeletInstance instance)` The absolute url to the example code's source file, as created by JavaDoc (in `{@docRoot}/src-html/`).
`static String`	`getJavaDocSourceUrl(CodeletInstance instance)` The absolute url to the example code's source file, as created by JavaDoc (in `{@docRoot}/src-html/`).
`static String`	`getJavaDocUrl(CodeletInstance instance)`
`static String`	`getJavaSourceFilePath(CodeletInstance instance)` The full on-disk path to the example code's source file.
`static String[]`	`getTagletTextSplitOnLineProcDelim(CodeletInstance instance)` The class-or-plain-text-file portion of the taglet text, split on the customizer delimiter character.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getExamplePackageName
```
public static final String getExamplePackageName(CodeletInstance instance)
                                          throws CodeletFormatException
```
    Get the example code's package name.
    
    Returns:
    Class.forName(getExampleClassFQName(instance)).getPackage().getName()
    
    Throws:
    
    CodeletFormatException
  - getExampleSimpleClassName
```
public static final String getExampleSimpleClassName(CodeletInstance instance)
                                              throws CodeletFormatException
```
    Get the example code's non-fully-qualified class name.
    
    Returns:
    Class.forName(getExampleClassFQName(instance)).getSimpleName()
    
    Throws:
    
    CodeletFormatException
  - getExampleClassFQName
```
public static final String getExampleClassFQName(CodeletInstance instance)
                                          throws CodeletFormatException
```
    The example code's fully-qualified class name.
    Returns:
    If this is a
    
    {@.codelet.out} or {@.codelet.and.out} taglet, and command-line parameters
    
    are specified: The class-portion of the taglet text before the open parenthesis ('('). Example:
    
    Class-portion: fully.qualified.examples.AnExample("param1", true, 3)
    
    Output: fully.qualified.examples.AnExample
    
    are not specified: The entire class-portion.
    
    {@.codelet} or {@.codelet.out} taglet: The entire class-portion
    Throws:
    
    CodeletFormatException
    See Also:
    getExampleCommandLineParams(CodeletInstance)
  - getExampleCommandLineParams
```
public static final String getExampleCommandLineParams(CodeletInstance instance)
                                                throws CodeletFormatException
```
    The example code's command-line parameters, as used by {@.codelet.out} and {@.codelet.and.out} taglets.
    Returns:
    If this is a {@.codelet.out} or {@.codelet.and.out} taglet, and command-line parameters
    
    are specified: The class-portion of the taglet text inside--but not including--the parentheses ('(' and ')'). Example:
    
    Class-portion: fully.qualified.examples.AnExample("param1", true, 3)
    
    Output: "param1", true, 3
    
    are not specified: "".
    Throws:
    
    CodeletFormatException
    See Also:
    getExampleClassFQName(CodeletInstance)
  - getFilePath
```
public static final String getFilePath(CodeletInstance instance)
```
    The full path to the plain-text file.
    
    Returns:
    getExampleClassOrFilePortionFromTagletText(instance)
    See Also:
    getFileNameWithExtension(CodeletInstance), getFileNameWithoutExtension(CodeletInstance)
  - getFileNameWithExtension
```
public static final String getFileNameWithExtension(CodeletInstance instance)
```
    The plain-text file name, including its dot-extension (such as ".txt"), if any.
    
    See Also:
    getFileNameWithoutExtension(CodeletInstance)
  - getFileNameWithoutExtension
```
public static final String getFileNameWithoutExtension(CodeletInstance instance)
```
    The plain-text file name, excluding its dot-extension (such as ".txt").
    
    See Also:
    getFileNameWithExtension(CodeletInstance)
  - getJavaSourceFilePath
```
public static final String getJavaSourceFilePath(CodeletInstance instance)
```
    The full on-disk path to the example code's source file.
    
    Example input
    1. fully-qualified class name: "fully.qualified.examples.AnExample"
    2. Base-directory: "C:\java_code\"
    Output
    
    "C:\java_code\fully\qualified\examples\AnExample.java"
    Returns:
    CodeletBaseConfig.getExampleSourceBaseDir() + getExampleClassFQName(instance).replace(".", FILE_SEP*) + ".java"
  - getJavaDocSourceUrl
```
public static final String getJavaDocSourceUrl(CodeletInstance instance)
```
    The absolute url to the example code's source file, as created by JavaDoc (in {@docRoot}/src-html/).
    
    Example input:
    1. Example code's fully-qualified class name: "fully.qualified.examples.AnExample"
    Output:
    
    "{@docRoot}/src-html/fully/qualified/examples/AnExample.html"
    
    Gap is filled with
    
    getJavaDocSourceUrl([the-instance])
    Returns:
    "../../../../src-html/" + getExampleClassFQName(instance).replace(".", "/") + ".html"
    See Also:
    getJavaDocExampleUrl(CodeletInstance)
  - getJavaDocUrl
```
public static final String getJavaDocUrl(CodeletInstance instance)
```
  - getJavaDocExampleUrl
```
public static final String getJavaDocExampleUrl(CodeletInstance instance)
```
    The absolute url to the example code's source file, as created by JavaDoc (in {@docRoot}/src-html/).
    
    Example input:
    1. Example code's fully-qualified class name: "fully.qualified.examples.AnExample"
    Output:
    
    "{@docRoot}/src-html/fully/qualified/examples/AnExample.html"
    
    Gap is filled with
    
    getJavaDocSourceUrl([the-instance])
    Returns:
    "../../../.." + getExampleClassFQName(instance).replace(".", "/") + ".html"
    See Also:
    getJavaDocSourceUrl(CodeletInstance)
  - getExampleClassOrFilePortionFromTagletText
```
public static final String getExampleClassOrFilePortionFromTagletText(CodeletInstance instance)
                                                               throws CodeletFormatException
```
    The example-class or plain-text-file portion of the taglet text.
    
    Returns:
    getTagletTextSplitOnLineProcDelim(instance)[0]
    
    Throws:
    
    CodeletFormatException
  - getTagletTextSplitOnLineProcDelim
```
public static final String[] getTagletTextSplitOnLineProcDelim(CodeletInstance instance)
                                                        throws CodeletFormatException
```
    The class-or-plain-text-file portion of the taglet text, split on the customizer delimiter character.
    Parameters:
    instance - May not be null
    
    Returns:
    If there is no line-proc (no delimiter char): A one element string array containing the class/file portion. Otherwise a two-element array, where element index one is the customizer portion.
    
    Throws:
    CodeletFormatException - If
    
    More than one customizer character is found. For including literal delimiters in string parameters, use CodeletInstance.CodeletInstance#ESCAPED_CUSTOMIZER_PREFIX_CHAR ESCAPED_CUSTOMIZER_PREFIX_CHAR.
    
    Either portion (class/file or line-proc) contains no characters.
    See Also:
    CodeletInstance.getText(), getExampleClassOrFilePortionFromTagletText(CodeletInstance), CodeletInstance#CUSTOMIZER_PREFIX_CHAR

Class TagletTextUtil

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getExamplePackageName

getExampleSimpleClassName

getExampleClassFQName

getExampleCommandLineParams

getFilePath

getFileNameWithExtension

getFileNameWithoutExtension

getJavaSourceFilePath

getJavaDocSourceUrl

getJavaDocUrl

getJavaDocExampleUrl

getExampleClassOrFilePortionFromTagletText

getTagletTextSplitOnLineProcDelim