byucc.jhdl.util.xmac
Class LicenseParser

java.lang.Object
  byucc.jhdl.util.xmac.TagParser
      byucc.jhdl.util.xmac.LicenseParser

public class LicenseParser

extends TagParser

Parse the license tag. This class parses the license tag in the input xmac file. Essentially the data in the license tag gets inserted in comment delimiters.

Example:
<license>Copyright: (C) 2002 Brigham Young University This program is free software; you can redistribute it and/or modify it under the terms of the Open Source Software License Agreement for JHDL. You should have received a copy of the Open Source Software License for JHDL along with this program. If you have not, download the License Agreement at http://www.jhdl.org/license.html or write to: Brad Hutchings 459 Clyde Bldg Brigham Young University Provo, UT 84602 </package>

Author:

Anthony Slade

Field Summary

Fields inherited from class byucc.jhdl.util.xmac.TagParser

docInfo

Constructor Summary

LicenseParser(DocInfo docInfo)
Construct a new LicenseParser object.

Method Summary

void	parse(java.lang.String license) Parse the license tag.

Methods inherited from class byucc.jhdl.util.xmac.TagParser

checkParent, countLines, decreaseIndent, increaseIndent, indentBlock, indentLine, indentLine, outmsg, parse, strBlockToArray, writeOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseParser

public LicenseParser(DocInfo docInfo)
              throws java.lang.Exception

Construct a new LicenseParser object.

Parameters:

docInfo - The DocInfo object containing information about the current class we're processing.

Method Detail

parse

public void parse(java.lang.String license)
           throws java.lang.Exception

Parse the license tag. This method starts the actual parsing of the license tag.

Overrides:

parse in class TagParser

Parameters:

license - The license text to be inserted. Note: This is different from most of the other parser classes. This one takes a String rather than a Node as the parameter.

Returns:

None

Throws:

java.lang.Exception