org.qunix.maven.structure.plugin.core

Class AbstractStructureNode<T>

java.lang.Object

org.qunix.maven.structure.plugin.core.AbstractStructureNode<T>

All Implemented Interfaces:

Serializable, Printable, StructureNode<T>

Direct Known Subclasses:

FileStructureNode, ModuleStructureNode

public abstract class AbstractStructureNode<T>
extends Object
implements StructureNode<T>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractStructureNode[]	childs
protected T	content
protected boolean	detailEnabled

Constructor Summary

Constructors

Constructor and Description
AbstractStructureNode(T content, boolean detailEnabled)

Method Summary

Modifier and Type	Method and Description
abstract String	getDetailedName()
String	getHeader() Header of output
String	getName() if detailed output is not asked then it will call StructureNode.getNodeName() else it will return full details
abstract String	getNodeName() Returns file.name or artifactId for maven project
String	getOutput(String levelStr) Returns tree output just for this node
boolean	hasMoreChilds(int index, String[] ignores) Utility method for below case: While you are iterating you know that you know there is more files but you are not sure if those files needs to be ignored.
boolean	isEmpty()
boolean	isValid(String[] ignores, String... parentName) Regex validation for single node

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.qunix.maven.structure.plugin.interfaces.StructureNode

getChilds, getParentName

Field Detail

childs

protected AbstractStructureNode[] childs

content

protected T content

detailEnabled

protected boolean detailEnabled

Constructor Detail

AbstractStructureNode

public AbstractStructureNode(T content,
                             boolean detailEnabled)
                      throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

Method Detail

getName

public String getName()
               throws org.apache.maven.plugin.MojoFailureException

Description copied from interface: StructureNode

if detailed output is not asked then it will call StructureNode.getNodeName() else it will return full details

Specified by:

getName in interface StructureNode<T>

Returns:

Throws:

org.apache.maven.plugin.MojoFailureException

hasMoreChilds

public boolean hasMoreChilds(int index,
                             String[] ignores)
                      throws org.apache.maven.plugin.MojoFailureException

Description copied from interface: StructureNode

Utility method for below case:
While you are iterating you know that you know there is more files but you are not sure if those files needs to be ignored. Then this utility class can help by given index and the ignore list

Specified by:

hasMoreChilds in interface StructureNode<T>

Parameters:

index - current index of iteration so the rest will be handled

ignores - regex patterns

Returns:

Boolean

Throws:

org.apache.maven.plugin.MojoFailureException

isValid

public boolean isValid(String[] ignores,
                       String... parentName)

Description copied from interface: StructureNode

Regex validation for single node

Specified by:

isValid in interface StructureNode<T>

Parameters:

ignores - regex patterns

parentName - this is for modules to validate if they are not printed multiple time referring to their parent

Returns:

Boolean

isEmpty

public boolean isEmpty()
                throws org.apache.maven.plugin.MojoFailureException

Specified by:

isEmpty in interface StructureNode<T>

Returns:

false if there is no child

Throws:

org.apache.maven.plugin.MojoFailureException

getNodeName

public abstract String getNodeName()

Description copied from interface: StructureNode

Returns file.name or artifactId for maven project

Specified by:

getNodeName in interface StructureNode<T>

Returns:

String

getDetailedName

public abstract String getDetailedName()
                                throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getOutput

public String getOutput(String levelStr)
                 throws org.apache.maven.plugin.MojoFailureException

Description copied from interface: Printable

Returns tree output just for this node

Specified by:

getOutput in interface Printable

Parameters:

levelStr - indentation

Returns:

String tree output just for this node

Throws:

org.apache.maven.plugin.MojoFailureException

getHeader

public String getHeader()
                 throws org.apache.maven.plugin.MojoFailureException

Description copied from interface: StructureNode

Header of output

Specified by:

getHeader in interface StructureNode<T>

Returns:

String

Throws:

org.apache.maven.plugin.MojoFailureException