Jive reference manual
List of all members | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
jive::app::InfoModule Class Reference

#include <jive/app/InfoModule.h>

Inheritance diagram for jive::app::InfoModule:
Inheritance graph

Public Member Functions

 InfoModule (const String &name="info")
 
virtual Status init (const Properties &conf, const Properties &props, const Properties &globdat)
 
virtual Status run (const Properties &globdat)
 
virtual bool takeAction (const String &action, const Properties &params, const Properties &globdat)
 
void printHelp (PrintWriter &out) const
 
- Public Member Functions inherited from jive::app::Module
 Module (const String &name="")
 
virtual void shutdown (const Properties &globdat)
 
virtual void configure (const Properties &props, const Properties &globdat)
 
virtual void getConfig (const Properties &conf, const Properties &globdat) const
 
virtual String getContext () const
 
void notAliveError () const
 
void notAliveError (const String &where) const
 
- Public Member Functions inherited from jem::NamedObject
 NamedObject (const String &name="")
 
virtual String toString () const
 Returns a short textual description of this object. More...
 
String getName () const
 
- Public Member Functions inherited from jem::Object
virtual ClassgetClass () const
 Returns the Class instance representing the runtime class of this object. More...
 
virtual long hashValue () const
 Returns a hash value for this object. More...
 
virtual bool equals (const Ref< Object > &obj) const
 Tests whether two objects are equal. More...
 
Ref< Objectclone () const
 Returns a copy of this object. More...
 

Static Public Member Functions

static void printSummary (PrintWriter &out, const Properties &globdat)
 
static Ref< ModulemakeNew (const String &name, const Properties &conf, const Properties &props, const Properties &globdat)
 
static void declare ()
 
- Static Public Member Functions inherited from jem::NamedObject
static String makeContext (const String &kind, const String &name)
 
- Static Public Member Functions inherited from jem::Object
static ClassgetType ()
 Returns the Class instance representing the Object class. More...
 

Static Public Attributes

static const char * TYPE_NAME
 
- Static Public Attributes inherited from jive::app::Module
static const char * CASE_NAME
 

Protected Member Functions

virtual ~InfoModule ()
 
- Protected Member Functions inherited from jive::app::Module
virtual ~Module ()
 
- Protected Member Functions inherited from jem::NamedObject
virtual ~NamedObject ()
 
- Protected Member Functions inherited from jem::Collectable
 Collectable ()
 Creates an empty Collectable. More...
 
 ~Collectable ()
 Frees resources. More...
 

Additional Inherited Members

- Public Types inherited from jive::app::Module
enum  Status {
  OK,
  DONE,
  EXIT
}
 
- Protected Attributes inherited from jem::NamedObject
String myName_
 

Constructor & Destructor Documentation

jive::app::InfoModule::InfoModule ( const String name = "info")
explicit
virtual jive::app::InfoModule::~InfoModule ( )
protectedvirtual

Member Function Documentation

virtual Status jive::app::InfoModule::init ( const Properties conf,
const Properties props,
const Properties globdat 
)
virtual

Reimplemented from jive::app::Module.

virtual Status jive::app::InfoModule::run ( const Properties globdat)
virtual

Reimplemented from jive::app::Module.

virtual bool jive::app::InfoModule::takeAction ( const String action,
const Properties params,
const Properties globdat 
)
virtual

Reimplemented from jive::app::Module.

void jive::app::InfoModule::printHelp ( PrintWriter out) const
static void jive::app::InfoModule::printSummary ( PrintWriter out,
const Properties globdat 
)
static
static Ref<Module> jive::app::InfoModule::makeNew ( const String name,
const Properties conf,
const Properties props,
const Properties globdat 
)
static
static void jive::app::InfoModule::declare ( )
static

Member Data Documentation

const char* jive::app::InfoModule::TYPE_NAME
static