Package org.biojava.nbio.structure.io.density

Class DensityMapRequest.Builder

java.lang.Object

org.biojava.nbio.structure.io.density.DensityMapRequest.Builder

Enclosing class:

DensityMapRequest

public static final class DensityMapRequest.Builder
extends Object

Builder for DensityMapRequest.

Since:

7.3.0

Author:

Amr ALHOSSARY

Method Summary

Modifier and Type	Method	Description
DensityMapRequest.Builder	allowNonRenderableFormats(boolean allow)
DensityMapRequest	build()
DensityMapRequest.Builder	cacheDir(File cacheDir)
DensityMapRequest.Builder	emdbId(String emdbId)
DensityMapRequest.Builder	fetchBehavior(LocalPDBDirectory.FetchBehavior fetchBehavior)
DensityMapRequest.Builder	kind(DensityMapKind kind)
DensityMapRequest.Builder	maxDownloadBytes(long bytes)
DensityMapRequest.Builder	sourceChain(List<DensityMapSource> chain)

Methods inherited from class java.lang.Object

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

Method Details

kind

public DensityMapRequest.Builder kind(DensityMapKind kind)

Parameters:

kind - the kind of map wanted; null means DensityMapKind.AUTO

emdbId

public DensityMapRequest.Builder emdbId(String emdbId)

Parameters:

emdbId - the EMDB entry to use, skipping the PDB-to-EMDB lookup

fetchBehavior

public DensityMapRequest.Builder fetchBehavior(LocalPDBDirectory.FetchBehavior fetchBehavior)

Parameters:

fetchBehavior - how aggressively to re-fetch

cacheDir

public DensityMapRequest.Builder cacheDir(File cacheDir)

Parameters:

cacheDir - an override for the cache directory

allowNonRenderableFormats

public DensityMapRequest.Builder allowNonRenderableFormats(boolean allow)

Parameters:

allow - whether formats that cannot be contoured directly may be used. A viewer should pass false.

maxDownloadBytes

public DensityMapRequest.Builder maxDownloadBytes(long bytes)

Parameters:

bytes - the download size limit, or 0 for no limit, or a negative value to use the cache's setting

sourceChain

public DensityMapRequest.Builder sourceChain(List<DensityMapSource> chain)

Parameters:

chain - an explicit source order, overriding the cache's choice

build

public DensityMapRequest build()

Returns:

the finished request