org.docgene.help.model

Class Chapter

java.lang.Object

org.docgene.help.model.Chapter

public class Chapter
extends java.lang.Object

Represents a Chapter in the Help content.

Constructor Summary

Constructors

Constructor and Description
Chapter(Localization localization)
Chapter(java.lang.String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addArticle(Article article) Add an article in this Chapter.
void	addChapter(Chapter chapter) Add a child Chapter to this Chapter.
boolean	equals(java.lang.Object obj)
java.util.List<Article>	getArticles() Return the articles which are directly under this Chapter.
java.util.List<Chapter>	getChapters() Return the list of children Chapters.
java.lang.String	getName() Return the chapter name.
Chapter	getParent() Return the parent chapter.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

Chapter

public Chapter(Localization localization)

Chapter

public Chapter(java.lang.String name)

Constructor.

Parameters:

name - the Chapter name

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Return the chapter name.

Returns:

the chapter name

getParent

public Chapter getParent()

Return the parent chapter.

Returns:

the parent chapter

addChapter

public void addChapter(Chapter chapter)

Add a child Chapter to this Chapter.

Parameters:

chapter - the child Chapter

getChapters

public java.util.List<Chapter> getChapters()

Return the list of children Chapters.

Returns:

the list of children Chapters

addArticle

public void addArticle(Article article)

Add an article in this Chapter.

Parameters:

article - the article

getArticles

public java.util.List<Article> getArticles()

Return the articles which are directly under this Chapter.

Returns:

the articles