com.github.aliteralmind.codelet.alter

Class NewLineAltererFor

java.lang.Object

com.github.aliteralmind.codelet.alter.NewLineAltererFor

public class NewLineAltererFor
extends Object

Convenience functions for creating line alterers tailored for codelets.

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:

TextLineAlterer, NewTextLineAltererFor

Method Summary

Methods

Modifier and Type	Method and Description
static TextLineAlterer	eliminateIndentationOrNull(String indentRegexToElim_emptyStrIfNone, Appendable debugDest_ifNonNull) Eliminates indentation from every line, if desired.
static TextLineAlterer	eliminatePackageLine(Appendable dbgEveryLine_ifNonNull, Appendable dbgPkgLnVldtr_ifNonNull) Eliminates the package declaration line.
static TextLineAlterer	elimPackageReferences(CodeletInstance instance, Appendable dbgRplcr_ifNonNull) Eliminates all references to a package.

Methods inherited from class java.lang.Object

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

Method Detail

elimPackageReferences

public static final TextLineAlterer elimPackageReferences(CodeletInstance instance,
                                    Appendable dbgRplcr_ifNonNull)

Eliminates all references to a package. Use in conjunction with eliminatePackageLine.

Returns:

NewTextLineAltererFor.replacement(AlterationRequired.YES,
   NewPatternFor.literal(TagletTextUtil.getExamplePackageName(instance) + "."),
   "", ReplacedInEachInput.ALL,
   dbgRplcr_ifNonNull,
   null)

eliminatePackageLine

public static final TextLineAlterer eliminatePackageLine(Appendable dbgEveryLine_ifNonNull,
                                   Appendable dbgPkgLnVldtr_ifNonNull)

Eliminates the package declaration line.

Returns:

NewTextLineAltererFor.text(packageLinePtrn, firstOccuranceFilter,
   dbgPkgLnVldtr_ifNonNull)

Where packageLinePtrn is
Pattern.compile(JavaRegexes.PACKAGE_DECL_ONE_LINE_NO_CMTS)
and firstOccuranceFilter is a
NewValidResultFilterFor.inUnchangedOutFalse(1, 1, null, null, dbgEveryLine_ifNonNull);

See Also:

elimPackageReferences

eliminateIndentationOrNull

public static final TextLineAlterer eliminateIndentationOrNull(String indentRegexToElim_emptyStrIfNone,
                                         Appendable debugDest_ifNonNull)

Eliminates indentation from every line, if desired.

Parameters:

indentRegexToElim_emptyStrIfNone - The regular expression representing the indentation to eliminate. May not be null. Must begin with a line-start anchor '^' and otherwise contain only spaces (' ') and tabs '\t'.

Returns:

If indentRegexToElim_emptyStrIfNone.length() is

• 0: null.
• One or greater:

  NewTextLineAltererFor.replacement(AlterationRequired.YES,
     Pattern.compile(indentRegexToElim_emptyStrIfNone), "",
     ReplacedInEachInput.FIRST, debugDest_ifNonNull, null)