org.jomc.util

Class Section

java.lang.Object

org.jomc.util.Section

public class Section
extends Object

Section of text.

Version:

$JOMC: Section.java 5043 2015-05-27 07:03:39Z schulte $

Author:

Christian Schulte

Constructor Summary

Constructors

Constructor and Description
Section() Creates a new Section instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEndingLine() Gets the line marking the end of this section.
StringBuilder	getHeadContent() Gets the content of this section preceding any child section content.
String	getName() Gets the name of this section.
Section	getSection(String sectionName) Gets a child section matching a given name.
List<Section>	getSections() Gets the child sections of this section.
String	getStartingLine() Gets the line marking the start of this section.
StringBuilder	getTailContent() Gets the content of this section succeeding any child section content.
void	setEndingLine(String value) Sets the line marking the end of this section.
void	setName(String value) Sets the name of this section.
void	setStartingLine(String value) Sets the line marking the start of this section.

Methods inherited from class java.lang.Object

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

Constructor Detail

Section

public Section()

Creates a new Section instance.

Method Detail

getName

public String getName()

Gets the name of this section.

Returns:

The name of this section or null.

setName

public void setName(String value)

Sets the name of this section.

Parameters:

value - The new name of this section or null.

getStartingLine

public String getStartingLine()

Gets the line marking the start of this section.

Returns:

The line marking the start of this section.

setStartingLine

public void setStartingLine(String value)

Sets the line marking the start of this section.

Parameters:

value - The new line marking the start of this section.

getEndingLine

public String getEndingLine()

Gets the line marking the end of this section.

Returns:

The line marking the end of this section.

setEndingLine

public void setEndingLine(String value)

Sets the line marking the end of this section.

Parameters:

value - The new line marking the end of this section.

getHeadContent

public StringBuilder getHeadContent()

Gets the content of this section preceding any child section content.

Returns:

The content of this section preceding any child section content.

getTailContent

public StringBuilder getTailContent()

Gets the content of this section succeeding any child section content.

Returns:

The content of this section succeeding any child section content.

getSections

public List<Section> getSections()

Gets the child sections of this section.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the object. This is why there is no set method for the sections property.

Returns:

A list of child sections of this section.

getSection

public Section getSection(String sectionName)

Gets a child section matching a given name.

Parameters:

sectionName - The name of the section to return.

Returns:

The first child section matching sectionName or null, if no such section is found.

Throws:

NullPointerException - if sectionName is null.