com.github.aliteralmind.codelet.taglet

Enum CodletComSunJavadocTagProcessor

java.lang.Object

java.lang.Enum<CodletComSunJavadocTagProcessor>

com.github.aliteralmind.codelet.taglet.CodletComSunJavadocTagProcessor

All Implemented Interfaces:

Serializable, Comparable<CodletComSunJavadocTagProcessor>

public enum CodletComSunJavadocTagProcessor
extends Enum<CodletComSunJavadocTagProcessor>

The interface between Java com.sun.javadoc.* and com.github.aliteralmind.codelet.*. The only dependencies on com.sun.javadoc.* are in this com.github.aliteralmind.codelet.taglet package. This is done in the interest of minimizing the dependency on com.sun.javadoc, which is not as cross-platform as Java itself.

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Methods

Modifier and Type	Method and Description
static String	get(Tag tag) Passes all taglet information to the codelet processor (without any references to com.sun.javadoc) and returns the text that replaces the taglet in the JavaDoc.
static CodletComSunJavadocTagProcessor	valueOf(String name) Returns the enum constant of this type with the specified name.
static CodletComSunJavadocTagProcessor[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final CodletComSunJavadocTagProcessor INSTANCE

Method Detail

values

public static CodletComSunJavadocTagProcessor[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CodletComSunJavadocTagProcessor c : CodletComSunJavadocTagProcessor.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CodletComSunJavadocTagProcessor valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public static final String get(Tag tag)

Passes all taglet information to the codelet processor (without any references to com.sun.javadoc) and returns the text that replaces the taglet in the JavaDoc.

Parameters:

tag - May not be null.

Returns:

(new TagletProcessor(instance)).get()

where

• instance is a

  new CodeletInstance(tag.name().substring(1),
     ComSunJavaDocUtil.getEnclosingPackageName(tag),
     ComSunJavaDocUtil.getEnclosingSimpleName(tag, IncludePostClassName.NO),
     pos.file(), pos.line(), tag.text(),
     ComSunJavaDocUtil.getRelativeUrlToDocRoot(tag))

• holder is tag.holder(), and
• pos is holder.position()

name().substring(1)} is to eliminate the trailing at-sign ('@'). Don't understand what that's part of it.

Throws:

RuntimeException - If the taglet is not successfully processed, for any reason. Get the causing exception with getCause().