de.hpi.fgis.dude.util.bibtex.data
Class BibtexToplevelComment

java.lang.Object
  de.hpi.fgis.dude.util.bibtex.data.BibtexNode
      de.hpi.fgis.dude.util.bibtex.data.BibtexAbstractEntry
          de.hpi.fgis.dude.util.bibtex.data.BibtexToplevelComment

public class BibtexToplevelComment
extends BibtexAbstractEntry

Top-level comments wrap everything that is at the top-level of a BibTex file and not parsable as some other entry. Note that many people think that the LaTeX comment symbol '%' can be used in BibTex. That's a myth - BibTex will just ignore that. If you want to comment out in BibTex, remove the '@' sign at the beginning of an entry.

Author:

henkel

Constructor Summary

protected

BibtexToplevelComment(BibtexFile file, String content) Creates a new BibtexToplevelComment.

Method Summary

String	getContent() Returns the content of this comment.
void	printBibtex(PrintWriter writer) Prints the node to the passed PrintWriter.
void	setContent(String content) Sets the content.

Methods inherited from class de.hpi.fgis.dude.util.bibtex.data.BibtexNode

getOwnerFile, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BibtexToplevelComment

protected BibtexToplevelComment(BibtexFile file,
                                String content)

Creates a new BibtexToplevelComment.

Parameters:

file - The file that includes this comment.

content - The content of this comment.

Method Detail

getContent

public String getContent()

Returns the content of this comment.

Returns:

The content of this comment or null if it is not set.

setContent

public void setContent(String content)

Sets the content.

Parameters:

content - The content to set.

printBibtex

public void printBibtex(PrintWriter writer)

Description copied from class: BibtexNode

Prints the node to the passed PrintWriter. This method needs to be implemented by each sub-class.

Specified by:

printBibtex in class BibtexNode

Parameters:

writer - The writer that shall be used for writing the String representation of this node.