de.vandermeer.skb.interfaces

Interface StandardExampleAsCmd

All Superinterfaces:

StandardExample

public interface StandardExampleAsCmd
extends StandardExample

A standard example with show (example output) and source (example code as quine) and provides a command.

Since:

v0.0.1

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
default String	getCmd() Returns a string that can be used as a command to execute the example.
String	getID() Returns an identifier for the example.

Methods inherited from interface StandardExample

getDescription, getSource, showOutput

Method Detail

getID

String getID()

Returns an identifier for the example. This is useful when a set of examples exist, and an application wants to build maps of them.

Returns:

example identifier, unique within the set of examples defined for a purpose, e.g. a package

getCmd

default String getCmd()

Returns a string that can be used as a command to execute the example. The default implementation simply uses the identifier as command string

Returns:

example command string