com.partnersoft.settings.framework.module

Class ModuleSettings

java.lang.Object

com.partnersoft.settings.framework.module.ModuleSettings

All Implemented Interfaces:

Coggable, CoggableSettings

public class ModuleSettings
extends java.lang.Object
implements CoggableSettings

A simple wrapper for a Module's settings. Assumes the type name is FooModuleSettings where Foo is the name of the module.
Copyright 2013 Partner Software, Inc.

Author:

Jeremy Tarver

Constructor Summary

Constructors

Constructor and Description
ModuleSettings(Module module)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getTypeName()
void	reload(Cog state) Resets the state of the Cog
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleSettings

public ModuleSettings(Module module)

Method Detail

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface CoggableSettings

Returns:

The name of the CogType

reload

public void reload(Cog state)

Description copied from interface: CoggableSettings

Resets the state of the Cog

Specified by:

reload in interface CoggableSettings

Parameters:

state - The Cog to reset values from