nz.org.riskscape.engine.ini.IniFileFunctionBuilder

All Implemented Interfaces:: IdentifiedObjectBuilder<nz.org.riskscape.engine.function.IdentifiedFunction>

public class IniFileFunctionBuilder extends IdentifiedObjectBuilder.Base<nz.org.riskscape.engine.function.IdentifiedFunction>

Builds a user-defined function from an INI definition.

Nested Class Summary

Nested classes/interfaces inherited from interface nz.org.riskscape.engine.ini.IdentifiedObjectBuilder
IdentifiedObjectBuilder.Base<T extends nz.org.riskscape.engine.Identified>
Field Summary

Fields

Modifier and Type

Field

Description

static final String

FRAMEWORK_KEY

static final String

FUNCTION_KEY

The INI file keyword to denote a function section
Constructor Summary

Constructors

Constructor

Description

IniFileFunctionBuilder(nz.org.riskscape.engine.Project project)
Method Summary

Modifier and Type

Method

Description

nz.org.riskscape.problem.ResultOrProblems<nz.org.riskscape.engine.function.IdentifiedFunction>

build(String id, nz.org.riskscape.config.ConfigSection section)

Builds the item based on the given INI section.

Methods inherited from class nz.org.riskscape.engine.ini.IdentifiedObjectBuilder.Base
getIdentifiedClass, getKeyword

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nz.org.riskscape.engine.ini.IdentifiedObjectBuilder
addToProject

Field Details
- FUNCTION_KEY
  
  public static final String FUNCTION_KEY
  
  The INI file keyword to denote a function section
  See Also:
  
  Constant Field Values
- FRAMEWORK_KEY
  
  public static final String FRAMEWORK_KEY
  See Also:
  
  Constant Field Values
Constructor Details
- IniFileFunctionBuilder
  
  public IniFileFunctionBuilder(nz.org.riskscape.engine.Project project)
Method Details
- build
  
  public nz.org.riskscape.problem.ResultOrProblems<nz.org.riskscape.engine.function.IdentifiedFunction> build(String id, nz.org.riskscape.config.ConfigSection section)
  
  Description copied from interface: IdentifiedObjectBuilder
  
  Builds the item based on the given INI section.
  
  Returns:
  
  the item successfully built, or any problems that occurred.

Class IniFileFunctionBuilder

Nested Class Summary