PropertiesDocBuilder

java.lang.Object

com.liferay.portal.tools.propertiesdoc.PropertiesDocBuilder

public class PropertiesDocBuilder extends Object

Author:: Jesse Rao, James Hinkey

Field Summary

Fields

Modifier and Type

Field

Description

protected static final String

DOUBLE_INDENT

protected static final String

INDENT
Constructor Summary

Constructors

Constructor

Description

PropertiesDocBuilder(Map<String,String> arguments)
Method Summary

Modifier and Type

Method

Description

protected void

addPropertyComment(List<PropertyComment> propertyComments, String comment)

protected List<String>

extractComments(String[] lines)

protected String

extractDefaultProperties(String[] lines)

protected String

extractExampleProperties(String[] lines)

protected List<PropertyComment>

extractPropertyComments(String[] lines)

protected String

extractTitle(String[] lines)

protected int

getLineCount(String sectionString)

protected List<PropertiesSection>

getPropertiesSections(File propertiesFile)

static void

main(String[] args)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- DOUBLE_INDENT
  
  protected static final String DOUBLE_INDENT
  See Also:
  
  Constant Field Values
- INDENT
  
  protected static final String INDENT
  See Also:
  
  Constant Field Values
Constructor Details
- PropertiesDocBuilder
  
  public PropertiesDocBuilder(Map<String,String> arguments) throws IOException
  
  Throws:
  
  IOException
Method Details
- main
  
  public static void main(String[] args) throws Exception
  
  Throws:
  
  Exception
- addPropertyComment
  
  protected void addPropertyComment(List<PropertyComment> propertyComments, String comment)
- extractComments
  
  protected List<String> extractComments(String[] lines)
- extractDefaultProperties
  
  protected String extractDefaultProperties(String[] lines)
- extractExampleProperties
  
  protected String extractExampleProperties(String[] lines)
- extractPropertyComments
  
  protected List<PropertyComment> extractPropertyComments(String[] lines)
- extractTitle
  
  protected String extractTitle(String[] lines)
- getLineCount
  
  protected int getLineCount(String sectionString)
- getPropertiesSections
  
  protected List<PropertiesSection> getPropertiesSections(File propertiesFile) throws IOException
  
  Throws:
  
  IOException