org.qunix.maven.structure.plugin.interfaces

Interface StructureNode<N>

All Superinterfaces:

Printable, Serializable

All Known Implementing Classes:

AbstractStructureNode, FileStructureNode, FolderStructureNode, ModuleStructureNode

public interface StructureNode<N>
extends Printable, Serializable

Method Summary

Modifier and Type	Method and Description
AbstractStructureNode[]	getChilds() Returns childs of element if any exist
String	getHeader() Header of output
String	getName() if detailed output is not asked then it will call getNodeName() else it will return full details
String	getNodeName() Returns file.name or artifactId for maven project
String	getParentName() this is for modules to validate if they are not printed multiple time referring to their parent, files always return null
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 interface org.qunix.maven.structure.plugin.interfaces.Printable

getOutput

Method Detail

getChilds

AbstractStructureNode[] getChilds()
                           throws org.apache.maven.plugin.MojoFailureException

Returns childs of element if any exist

Returns:

list of AbstractStructureNode

Throws:

org.apache.maven.plugin.MojoFailureException

hasMoreChilds

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

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

Parameters:

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

ignores - regex patterns

Returns:

Boolean

Throws:

org.apache.maven.plugin.MojoFailureException

isValid

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

Regex validation for single node

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

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

Returns:

false if there is no child

Throws:

org.apache.maven.plugin.MojoFailureException

getNodeName

String getNodeName()

Returns file.name or artifactId for maven project

Returns:

String

getName

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

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

Returns:

Throws:

org.apache.maven.plugin.MojoFailureException

getHeader

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

Header of output

Returns:

String

Throws:

org.apache.maven.plugin.MojoFailureException

getParentName

String getParentName()

this is for modules to validate if they are not printed multiple time referring to their parent, files always return null

Returns: