com.arsdigita.initializer
Interface Initializer

All Known Implementing Classes:
BaseInitializer, CharsetEncodingProviderInitializer, DomainObjectTraversalInitializer, GenericInitializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, Initializer, SyncInitializer

public interface Initializer

Any class implementing this interface may appear in an initialization script read in by the Script class. A class that does this should construct its own configuration object and initialize the parameters with the appropriate types and default values. This object should be returned by the getConfiguration() method. This configuration object will then be filled out by the Script class with whatever values appear in the initialization script.

  public class MyInitializer implements Initializer {

      Configuration m_config = new Configuration();

      public MyInitializer() throws InitializationException {
          m_config.initParameter("stringParam", "This is a usage string.",
                                 String.class,"This is a string.");
          m_config.initParameter("intParam",
                                 "Please enter a value for the intParam.")
          m_config.initParameter("listParam", "Should be a list.",
                                 java.util.List.class, new ArrayList());
      }

      public Configuration getConfiguration() {
          return m_config;
      }

      public void startup() {
          // Run startup code here.
      }

      public void shutdown() {
          // Run shutdown code here.
      }

  }
  
The following syntax may then be used in an initialization script:
  init MyInitializer {
      stringParam = "foo";
      intParam = 3;
      listParam = { "foo", "bar", "baz" };
  }
  

Version:
$Revision: #6 $ $Date: 2004/04/07 $
Author:
rhs@mit.edu

Field Summary
static String versionId
           
 
Method Summary
 Configuration getConfiguration()
          Returns the configuration object used by this initializer.
 void shutdown()
          Called on shutdown.
 void startup()
          Called on startup.
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Method Detail

getConfiguration

public Configuration getConfiguration()
Returns the configuration object used by this initializer.


startup

public void startup()
             throws InitializationException
Called on startup.

Throws:
InitializationException

shutdown

public void shutdown()
              throws InitializationException
Called on shutdown. It's probably not a good idea to depend on this being called.

Throws:
InitializationException


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC