com.evrythng.java.wrapper.core

Class ExampleRunner

java.lang.Object

com.evrythng.java.wrapper.core.ExampleRunner

Direct Known Subclasses:

CollectionApiExample, ExceptionHandlingExample, SimpleExample, ThngApiExample, ThngPropertyApiExample

public abstract class ExampleRunner
extends Object

Base definition for implementing examples on top of the EVRYTHNG API wrapper.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExampleRunner(ApiConfiguration config) Creates a new instance of ExampleRunner using the provided ApiConfiguration.

Method Summary

Modifier and Type	Method and Description
protected abstract void	doRun() Concrete implementation.
static void	echo(String message) Logs the provided message.
static void	echo(String format, Object... args) Logs an INFO message according to the specified format and arguments.
static ApiConfiguration	extractConfig(String[] args) Extracts required parameters from program args.
ApiConfiguration	getConfig()
void	run() Runs the current example.
static void	usage() Displays the usage information.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleRunner

protected ExampleRunner(ApiConfiguration config)

Creates a new instance of ExampleRunner using the provided ApiConfiguration.

Parameters:

config - ApiConfiguration instance

Method Detail

run

public void run()
         throws EvrythngException

Runs the current example.

Throws:

EvrythngException

doRun

protected abstract void doRun()
                       throws EvrythngException

Concrete implementation.

Throws:

EvrythngException

extractConfig

public static ApiConfiguration extractConfig(String[] args)

Extracts required parameters from program args.

Parameters:

args - program arguments

Returns:

ApiConfiguration instance

usage

public static void usage()

Displays the usage information.

echo

public static void echo(String message)

Logs the provided message.

Parameters:

message - message

echo

public static void echo(String format,
                        Object... args)

Logs an INFO message according to the specified format and arguments. Arguments will be jsonified before string replacement.

Parameters:

format - format

args - arguments

getConfig

public ApiConfiguration getConfig()