Package gov.usgs.earthquake.nshmp.tree

Class LogicTree.Builder<T>

java.lang.Object

gov.usgs.earthquake.nshmp.tree.LogicTree.Builder<T>

Direct Known Subclasses:

LogicGroup.Builder, LogicTree.EnumBuilder, LogicTree.EnumValueBuilder, LogicTree.StringValueBuilder

Enclosing interface:

LogicTree<T>

public static class LogicTree.Builder<T>
extends Object

A single-use LogicTree builder.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String name)	Sole package constructor; use LogicTree.builder(String) instead.

Method Summary

Modifier and Type	Method	Description
LogicTree.Builder<T>	addBranch(String id, T value, double weight)	Add a branch to the tree.
LogicTree<T>	build()	Return a newly created LogicTree.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(String name)

Sole package constructor; use LogicTree.builder(String) instead.

Parameters:

name - of the tree

Method Detail

addBranch

public LogicTree.Builder<T> addBranch(String id,
                                      T value,
                                      double weight)

Add a branch to the tree.

Parameters:

id - of the branch

value - of the branch

weight - of the branch

Returns:

this Builder object

Throws:

NullPointerException - if id or value is null

IllegalArgumentException - if id is empty or whitespace

IllegalArgumentException - if a branch with id has already been added

IllegalArgumentException - if weight is outside the range (0..1]

build

public LogicTree<T> build()

Return a newly created LogicTree.

Throws:

IllegalStateException - if this method has already been called

IllegalStateException - if the logic tree is empty (i.e. no branches have been added)

IllegalStateException - if branch weights do not sum to 1.0 ± 0.00001