Package com.github.tadukoo.parsing.fileformat

Class FormatNode

java.lang.Object

com.github.tadukoo.parsing.fileformat.FormatNode

public class FormatNode
extends Object

Represents all the information about how a Node should be formatted for a FileFormat.

Since:

Alpha v.0.1

Version:

Alpha v.0.3

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormatNode.FormatNodeBuilder	Builder for constructing a FormatNode object.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	childNames	Names of allowed children of the Node
private final String	dataRegex	The regex used to ensure the data is of the correct format
private final int	level	The required level of the Node
private final String	name	The name of the Node - used to distinguish in parent/child/sibling requirements
private final List<String>	nextSiblingNames	Names of allowed next siblings of the Node
static final String	NULL_NODE	The text used to signify a null (e.g.
private final List<String>	parentNames	Names of allowed parents of the Node
private final List<String>	prevSiblingNames	Names of allowed previous siblings of the Node
private final String	titleRegex	The regex used to ensure the title is of the correct format

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FormatNode(String name, String titleRegex, String dataRegex, int level, List<String> parentNames, List<String> childNames, List<String> prevSiblingNames, List<String> nextSiblingNames)	Constructs a FormatNode with the given data.

Method Summary

Modifier and Type	Method	Description
static FormatNode.FormatNodeBuilder	builder()	Constructs a FormatNode.FormatNodeBuilder to be used to construct a FormatNode.
List<String>	getChildNames()
String	getDataRegex()
int	getLevel()
String	getName()
List<String>	getNextSiblingNames()
String	getNodeRegex()
List<String>	getParentNames()
List<String>	getPrevSiblingNames()
String	getTitleRegex()
String	toString()	Convert this FormatNode into Nodes to be converted into text to be stored and later loaded if needed.

Methods inherited from class java.lang.Object

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

Field Details

NULL_NODE

public static final String NULL_NODE

The text used to signify a null (e.g. as an allowed Node for parent/child/sibling)

See Also:

• Constant Field Values

name

private final String name

The name of the Node - used to distinguish in parent/child/sibling requirements

titleRegex

private final String titleRegex

The regex used to ensure the title is of the correct format

dataRegex

private final String dataRegex

The regex used to ensure the data is of the correct format

level

private final int level

The required level of the Node

parentNames

private final List<String> parentNames

Names of allowed parents of the Node

childNames

private final List<String> childNames

Names of allowed children of the Node

prevSiblingNames

private final List<String> prevSiblingNames

Names of allowed previous siblings of the Node

nextSiblingNames

private final List<String> nextSiblingNames

Names of allowed next siblings of the Node

Constructor Details

FormatNode

private FormatNode(String name,
 String titleRegex,
 String dataRegex,
 int level,
 List<String> parentNames,
 List<String> childNames,
 List<String> prevSiblingNames,
 List<String> nextSiblingNames)

Constructs a FormatNode with the given data.

Parameters:

name - The name of the Node

titleRegex - The regex to ensure the title is of the correct format

dataRegex - The regex to ensure the data is of the correct format

level - The required level of the Node

parentNames - The names of allowed parent Nodes to this one

childNames - The names of allowed child Nodes to this one

prevSiblingNames - The names of allowed previous sibling Nodes to this one

nextSiblingNames - The names of allowed next sibling Nodes to this one

Method Details

builder

public static FormatNode.FormatNodeBuilder builder()

Constructs a FormatNode.FormatNodeBuilder to be used to construct a FormatNode.

Returns:

A new FormatNodeBuilder

getName

public String getName()

Returns:

The name for the Node

getTitleRegex

public String getTitleRegex()

Returns:

The regex to use in ensuring the title is formatted correctly

getDataRegex

public String getDataRegex()

Returns:

The regex to use in ensuring the data is formatted correctly

getNodeRegex

public String getNodeRegex()

Returns:

The title regex and data regex combined, separated by a colon

getLevel

public int getLevel()

Returns:

The required level of the Node

getParentNames

public List<String> getParentNames()

Returns:

The allowed names for parent Nodes of this one

getChildNames

public List<String> getChildNames()

Returns:

The allowed names for child Nodes of this one

getPrevSiblingNames

public List<String> getPrevSiblingNames()

Returns:

The allowed names for previous sibling Nodes of this one

getNextSiblingNames

public List<String> getNextSiblingNames()

Returns:

The allowed names for next sibling Nodes of this one

toString

public String toString()

Convert this FormatNode into Nodes to be converted into text to be stored and later loaded if needed.

Overrides:

toString in class Object

Returns:

The String representation of this FormatNode