org.opends.server.admin

Class PropertyDefinitionUsageBuilder

java.lang.Object

org.opends.server.admin.PropertyDefinitionUsageBuilder

public final class PropertyDefinitionUsageBuilder
extends Object

A property definition visitor which can be used to generate syntax usage information.

Constructor Summary

Constructors

Constructor and Description
PropertyDefinitionUsageBuilder(boolean isDetailed) Creates a new property usage builder.

Method Summary

Methods

Modifier and Type	Method and Description
LocalizableMessage	getUsage(PropertyDefinition<?> pd) Generates the usage information for the provided property definition.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyDefinitionUsageBuilder

public PropertyDefinitionUsageBuilder(boolean isDetailed)

Creates a new property usage builder.

Parameters:

isDetailed - Indicates whether or not the generated usage should contain detailed information such as constraints.

Method Detail

getUsage

public LocalizableMessage getUsage(PropertyDefinition<?> pd)

Generates the usage information for the provided property definition.

Parameters:

pd - The property definitions.

Returns:

Returns the usage information for the provided property definition.