jklustor-all-api-0.0.7-20140619012755 (ChemAxon)


com.chemaxon.descriptors.fingerprints.ecfp
Class EcfpParameters.Builder

Object
  extended by com.chemaxon.descriptors.fingerprints.ecfp.EcfpParameters.Builder
All Implemented Interfaces:
ParameterBuilder<EcfpParameters>
Enclosing class:
EcfpParameters

public static class EcfpParameters.Builder
extends Object
implements ParameterBuilder<EcfpParameters>

Builder class for the immutable parameter object.


Constructor Summary
EcfpParameters.Builder()
          Constructor with default settings.
EcfpParameters.Builder(EcfpParameters parameters)
          Constructor based on a parameter object.
 
Method Summary
 EcfpParameters.Builder atomTypizer(EcfpAtomTypizers atomTypizer)
          Set atom typizer to use.
 EcfpParameters build()
          Constructs an immutable instance of T.
 EcfpParameters.Builder diameter(int diameter)
          Sets diameter.
 EcfpParameters.Builder length(int length)
          Set fingerprint length, the bit count of the folded binary fingerprint representation.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EcfpParameters.Builder

public EcfpParameters.Builder()
Constructor with default settings.


EcfpParameters.Builder

public EcfpParameters.Builder(EcfpParameters parameters)
Constructor based on a parameter object.

Parameters:
parameters - Parameter object
Method Detail

diameter

public EcfpParameters.Builder diameter(int diameter)
Sets diameter.

Parameters:
diameter - Diameter to set
Returns:
Reference to this builder
Throws:
IllegalArgumentException - when the set diameter is a negative or odd number

length

public EcfpParameters.Builder length(int length)
Set fingerprint length, the bit count of the folded binary fingerprint representation.

Parameters:
length - new length
Returns:
Reference to this builder
Throws:
IllegalArgumentException - when the set length is not a positive number, or not multiply of 32

atomTypizer

public EcfpParameters.Builder atomTypizer(EcfpAtomTypizers atomTypizer)
Set atom typizer to use.

Parameters:
atomTypizer - Atom typizer to use
Returns:
Reference to this builder

build

public EcfpParameters build()
Description copied from interface: ParameterBuilder
Constructs an immutable instance of T.

Specified by:
build in interface ParameterBuilder<EcfpParameters>
Returns:
An immutable instance of T

jklustor-all-api-0.0.7-20140619012755 (ChemAxon)