com.ptc.windchill.structconf.xconf
Class PropertyDocumentation

java.lang.Object
  com.ptc.windchill.structconf.xconf.PropertyDocumentation

public final class PropertyDocumentation

extends Object

Encapsulates documentation for a property declared in xconf files.

Field Summary

private String	category_
private String	deprecation_
private String	description_
private String	key_
private String	synopsis_

Constructor Summary

(package private)

PropertyDocumentation(String property_name)

Method Summary

String	getCategory() Category in which the property documentation should be grouped.
String	getDeprecation()
String	getDescription() String containing an HTML description of the property.
String	getKey() The key by which this documentation should be identified in the documentation.
String	getNormalizedCategory() The category string of the documentation normalized to be an anchor name.
String	getSynopsis() String containing an HTML synopsis of the property.
(package private) void	setCategory(String category)
(package private) void	setDeprecation(String deprecation)
(package private) void	setDescription(String description)
(package private) void	setKey(String key)
(package private) void	setSynopsis(String synopsis)
String	toString() A developer oriented representation of the documentation info.

Methods inherited from class java.lang.Object

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

Field Detail

category_

private String category_

key_

private String key_

synopsis_

private String synopsis_

description_

private String description_

deprecation_

private String deprecation_

Constructor Detail

PropertyDocumentation

PropertyDocumentation(String property_name)

Method Detail

toString

public String toString()

A developer oriented representation of the documentation info.

setCategory

void setCategory(String category)

setKey

void setKey(String key)

setSynopsis

void setSynopsis(String synopsis)

setDescription

void setDescription(String description)

setDeprecation

void setDeprecation(String deprecation)

getNormalizedCategory

public String getNormalizedCategory()

The category string of the documentation normalized to be an anchor name. In this format it has whitespace removed and is all lowercased.

getCategory

public String getCategory()

Category in which the property documentation should be grouped.

getKey

public String getKey()

The key by which this documentation should be identified in the documentation.

getSynopsis

public String getSynopsis()

String containing an HTML synopsis of the property.

getDescription

public String getDescription()

String containing an HTML description of the property.

getDeprecation

public String getDeprecation()

Returns:

null if the property is deprecated, a string otherwise