UsageFormatter (OpenAM Project 16.0.0-SNAPSHOT API)

java.lang.Object
- com.sun.identity.cli.UsageFormatter

public class UsageFormatter
extends Object

This format the usage text of CLI.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`format(CommandManager mgr)`	Prints the usage of CLI.
`void`	`format(CommandManager mgr, SubCommand cmd)`	Prints the usage of sub command.
`static UsageFormatter`	`getInstance()`	Returns an instance of this class.

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

- Method Detail
  - getInstance
```
public static UsageFormatter getInstance()
```
    Returns an instance of this class.
    
    Returns:
    
    an instance of this class.
  - format
```
public void format(CommandManager mgr)
            throws CLIException
```
    Prints the usage of CLI.
    
    Parameters:
    
    mgr - Command Manager object.
    
    Throws:
    
    CLIException - if usage text cannot be presented.
  - format
```
public void format(CommandManager mgr,
                   SubCommand cmd)
            throws CLIException
```
    Prints the usage of sub command.
    
    Parameters:
    
    mgr - Command Manager object.
    
    cmd - Sub command object.
    
    Throws:
    
    CLIException - if usage text cannot be presented.