TypeSpecificConfig

All Known Subinterfaces:: TypeSpecificWireConfigProvider

public interface TypeSpecificConfig

Marker interface for type specific configuration.

Method Summary

Modifier and Type	Method	Description
`org.jdom2.Element`	`generateConfig()`	Generate the configuration XML Element.
`default void`	`installConfig()`	Install the verified configuration.
`void`	`verifyConfig(org.jdom2.Element element, BiFunction<String,Integer,Double> determineMaxHeapFunction)`	Given the element (off the xml file's root), verify the configuration entries and pre-load them.

Method Details
- verifyConfig
  
  void verifyConfig(org.jdom2.Element element, BiFunction<String,Integer,Double> determineMaxHeapFunction) throws ConfigurationVerificationException
  
  Given the element (off the xml file's root), verify the configuration entries and pre-load them. Do not activate them.
  
  Parameters:
  
  element - the Element that was generated by this ReloadableConfiguration's generateConfig call
  
  determineMaxHeapFunction - a function that determines the maximum heap for a worker
  
  Throws:
  
  ConfigurationVerificationException - if the element has an error
- installConfig
  
  default void installConfig()
  
  Install the verified configuration.
- generateConfig
  
  org.jdom2.Element generateConfig() throws IOException
  
  Generate the configuration XML Element. This may involve reading a Configuration instance and performing other actions.
  
  Returns:
  
  an Element that can be used to load the configuration. This will be passed to verifyConfig.
  
  Throws:
  
  IOException