com.github.aliteralmind.codelet.alter

Class NewJavaDocLinkReplacerFor

java.lang.Object

com.github.aliteralmind.codelet.alter.NewJavaDocLinkReplacerFor

public class NewJavaDocLinkReplacerFor
extends Object

Convenience functions for creating com.github.xbn.regexutil.RegexReplacers that replace a class, constructor, function, or object name with a clickable JavaDoc link.

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:

NewJDLinkForWordOccuranceNum

Method Summary

Methods

Modifier and Type	Method and Description
static RegexReplacer	cclass(CodeletInstance instance, Class target, Appendable dbgDest_ifNonNull) Changes a class name to a JavaDoc link.
static RegexReplacer	constructor(CodeletInstance instance, Constructor<?> target, Appendable dbgDest_ifNonNull) Changes a constructor name to a JavaDoc link.
static RegexReplacer	field(CodeletInstance instance, Field target, Appendable dbgDest_ifNonNull) Changes a field name (an object existing in another class) to a JavaDoc link.
static String	getDocRootUrlToTargetClass(CodeletInstance instance, Class<?> target) Get the {@docRoot} url for a package, which may be internal or external.
static RegexReplacer	method(CodeletInstance instance, Method target, Appendable dbgDest_ifNonNull) Changes a function name to a JavaDoc link.
static RegexReplacer	newReplaceCnstrFuncNameOpenParenWith(String word_findWhat, String link_rplcWith, Appendable dbgDest_ifNonNull) A new replacer for replacing the first occurance of a whole word with a link.
static RegexReplacer	newReplaceWordOnlyWith(String word_findWhat, String link_rplcWith, Appendable dbgDest_ifNonNull) A new replacer for replacing the first occurance of a class or field name with a link.

Methods inherited from class java.lang.Object

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

Method Detail

cclass

public static final RegexReplacer cclass(CodeletInstance instance,
                   Class target,
                   Appendable dbgDest_ifNonNull)

Changes a class name to a JavaDoc link.

Parameters:

instance - May not be null.

target - May not be null.

Returns:

newReplaceWordOnlyWith(
target.getName(), link, dbgDest_ifNonNull)
Where the link's url is
JavaDocUtil.getUrlToClass(instance.getRelativeUrlToDocRoot(), target)
and display is the class's simple name.

newReplaceCnstrFuncNameOpenParenWith

public static final RegexReplacer newReplaceCnstrFuncNameOpenParenWith(String word_findWhat,
                                                 String link_rplcWith,
                                                 Appendable dbgDest_ifNonNull)

A new replacer for replacing the first occurance of a whole word with a link.

Returns:

new RegexReplacer_Cfg().
com.github.xbn.regexutil.z.RegexReplacer_CfgForNeeder#direct(String, Object)(Pattern.compile("\\b" + word_findWhat + "\\b([ \\t]\*\()"), link_rplcWith + "$1").
debugTo(dbgDest_ifNonNull).first().build()

See Also:

newReplaceWordOnlyWith

newReplaceWordOnlyWith

public static final RegexReplacer newReplaceWordOnlyWith(String word_findWhat,
                                   String link_rplcWith,
                                   Appendable dbgDest_ifNonNull)

A new replacer for replacing the first occurance of a class or field name with a link.

Returns:

new RegexReplacer_Cfg().
com.github.xbn.regexutil.z.RegexReplacer_CfgForNeeder#direct(String, Object)(Pattern.compile("\\b" + word_findWhat + "\\b"), link_rplcWith).
debugTo(dbgDest_ifNonNull).first().build()

See Also:

newReplaceCnstrFuncNameOpenParenWith

constructor

public static final RegexReplacer constructor(CodeletInstance instance,
                        Constructor<?> target,
                        Appendable dbgDest_ifNonNull)

Changes a constructor name to a JavaDoc link.

method

public static final RegexReplacer method(CodeletInstance instance,
                   Method target,
                   Appendable dbgDest_ifNonNull)

Changes a function name to a JavaDoc link.

Parameters:

instance - May not be null.

target - May not be null.

Returns:

newReplaceCnstrFuncNameOpenParenWith(
target.getName(), link, dbgDest_ifNonNull)
Where the link's url is
JavaDocUtil.getUrlToMethod(instance.getRelativeUrlToDocRoot(), target)
and display is the method's name.

field

public static final RegexReplacer field(CodeletInstance instance,
                  Field target,
                  Appendable dbgDest_ifNonNull)

Changes a field name (an object existing in another class) to a JavaDoc link.

Parameters:

instance - May not be null.

target - May not be null.

Returns:

newReplaceWordOnlyWith(target.getName(), link, dbgDest_ifNonNull)
Where the link's url is
JavaDocUtil.getUrlToField(instance.getRelativeUrlToDocRoot(), target)
and display is the field's name.

getDocRootUrlToTargetClass

public static final String getDocRootUrlToTargetClass(CodeletInstance instance,
                                Class<?> target)

Get the {@docRoot} url for a package, which may be internal or external.

Parameters:

instance - May not be null.

target - The class being linked to. May not be null, and must be in a package (target.getPackage().getName() must be non-empty).

Returns:

If CodeletBaseConfig.getAllJavaDocRoots().getPkgToUrlMap().get(target.getPackage().getName()) is

• non-null: The value returned from the map.
• null: instance.getRelativeUrlToDocRoot()