HelpExample.java

/*
 * Copyright 2012-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.cli.command;

/**
 * An example that can be displayed in the help.
 *
 * @author Phillip Webb
 * @since 1.2.0
 */
public class HelpExample {

	private final String description;

	private final String example;

	/**
	 * Create a new {@link HelpExample} instance.
	 * @param description The description (in the form "to ....")
	 * @param example the example
	 */
	public HelpExample(String description, String example) {
		this.description = description;
		this.example = example;
	}

	public String getDescription() {
		return this.description;
	}

	public String getExample() {
		return this.example;
	}

}