org.apache.maven.doxia.index

Class IndexingSink

public class IndexingSink extends SinkAdapter

A sink implementation for index

Version: $Id: IndexingSink.java 559578 2007-07-25 20:12:56Z ltheussl $

Author: Trygve Laugstøl Vincent Siveton

Constructor Summary
	IndexingSink(IndexEntry sectionEntry) Default constructor.

Method Summary
String	getTitle()
IndexEntry	peek()
void	pop() Removes the IndexEntry at the top of this stack
void	push(IndexEntry entry) Pushes an IndexEntry onto the top of this stack
void	section1_()
void	section2_()
void	section3_()
void	section4_()
void	section5_()
void	sectionTitle1()
void	sectionTitle2()
void	sectionTitle3()
void	sectionTitle4()
void	sectionTitle5()
void	text(String text)
void	title()

Constructor Detail

IndexingSink

public IndexingSink(IndexEntry sectionEntry)

Default constructor.

Parameters: sectionEntry The first index entry.

Method Detail

getTitle

public String getTitle()

Returns: the title

peek

public IndexEntry peek()

Returns: Looks at the IndexEntry at the top of this stack

pop

public void pop()

Removes the IndexEntry at the top of this stack

push

public void push(IndexEntry entry)

Pushes an IndexEntry onto the top of this stack

Parameters: entry to put

section1_

public void section1_()

{@inheritDoc }

section2_

public void section2_()

{@inheritDoc }

section3_

public void section3_()

{@inheritDoc }

section4_

public void section4_()

{@inheritDoc }

section5_

public void section5_()

{@inheritDoc }

sectionTitle1

public void sectionTitle1()

{@inheritDoc }

sectionTitle2

public void sectionTitle2()

{@inheritDoc }

sectionTitle3

public void sectionTitle3()

{@inheritDoc }

sectionTitle4

public void sectionTitle4()

{@inheritDoc }

sectionTitle5

public void sectionTitle5()

{@inheritDoc }

text

public void text(String text)

{@inheritDoc }

title

public void title()

{@inheritDoc }

Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.