org.springframework.boot.cli.command

Class HelpExample

java.lang.Object

org.springframework.boot.cli.command.HelpExample

public class HelpExample
extends Object

An example that can be displayed in the help.

Since:

1.2.0

Author:

Phillip Webb

Constructor Summary

Constructors

Constructor and Description
HelpExample(String description, String example) Create a new HelpExample instance.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getExample()

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpExample

public HelpExample(String description,
                   String example)

Create a new HelpExample instance.

Parameters:

description - the description (in the form "to ....")

example - the example

Method Detail

getDescription

public String getDescription()

getExample

public String getExample()