001/* 002 * Copyright 2012-2016 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.boot.cli.command; 018 019/** 020 * An example that can be displayed in the help. 021 * 022 * @author Phillip Webb 023 * @since 1.2.0 024 */ 025public class HelpExample { 026 027 private final String description; 028 029 private final String example; 030 031 /** 032 * Create a new {@link HelpExample} instance. 033 * @param description The description (in the form "to ....") 034 * @param example the example 035 */ 036 public HelpExample(String description, String example) { 037 this.description = description; 038 this.example = example; 039 } 040 041 public String getDescription() { 042 return this.description; 043 } 044 045 public String getExample() { 046 return this.example; 047 } 048 049}