com.liferay.portal.tools.propertiesdoc

Class PropertiesDocBuilder

java.lang.Object

com.liferay.portal.tools.propertiesdoc.PropertiesDocBuilder

public class PropertiesDocBuilder
extends java.lang.Object

Author:

Jesse Rao, James Hinkey

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DOUBLE_INDENT
protected static java.lang.String	INDENT

Constructor Summary

Constructors

Constructor and Description
PropertiesDocBuilder(java.util.Map<java.lang.String,java.lang.String> arguments)

Method Summary

Modifier and Type	Method and Description
protected void	addPropertyComment(java.util.List<PropertyComment> propertyComments, java.lang.String comment)
protected java.util.List<java.lang.String>	extractComments(java.lang.String[] lines)
protected java.lang.String	extractDefaultProperties(java.lang.String[] lines)
protected java.lang.String	extractExampleProperties(java.lang.String[] lines)
protected java.util.List<PropertyComment>	extractPropertyComments(java.lang.String[] lines)
protected java.lang.String	extractTitle(java.lang.String[] lines)
protected int	getLineCount(java.lang.String sectionString)
protected java.util.List<PropertiesSection>	getPropertiesSections(java.io.File propertiesFile)
static void	main(java.lang.String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

DOUBLE_INDENT

protected static final java.lang.String DOUBLE_INDENT

See Also:

Constant Field Values

INDENT

protected static final java.lang.String INDENT

See Also:

Constant Field Values

Constructor Detail

PropertiesDocBuilder

public PropertiesDocBuilder(java.util.Map<java.lang.String,java.lang.String> arguments)
                     throws java.io.IOException

Throws:

java.io.IOException

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

addPropertyComment

protected void addPropertyComment(java.util.List<PropertyComment> propertyComments,
                                  java.lang.String comment)

extractComments

protected java.util.List<java.lang.String> extractComments(java.lang.String[] lines)

extractDefaultProperties

protected java.lang.String extractDefaultProperties(java.lang.String[] lines)

extractExampleProperties

protected java.lang.String extractExampleProperties(java.lang.String[] lines)

extractPropertyComments

protected java.util.List<PropertyComment> extractPropertyComments(java.lang.String[] lines)

extractTitle

protected java.lang.String extractTitle(java.lang.String[] lines)

getLineCount

protected int getLineCount(java.lang.String sectionString)

getPropertiesSections

protected java.util.List<PropertiesSection> getPropertiesSections(java.io.File propertiesFile)
                                                           throws java.io.IOException

Throws:

java.io.IOException