Package org.rcsb.cif.model.builder

Class CifFileBuilderImpl

java.lang.Object

org.rcsb.cif.model.builder.CifFileBuilderImpl

All Implemented Interfaces:

CifFileBuilder

Direct Known Subclasses:

CifCoreFileBuilder, MmCifFileBuilder

public class CifFileBuilderImpl
extends Object
implements CifFileBuilder

Constructor Summary

Constructors

Constructor	Description
CifFileBuilderImpl()

Method Summary

Modifier and Type	Method	Description
CifFileBuilder	addBlock(Block block)	Add a block to this builder.
CifFile	build()	Build the file described by this builder.
void	digest(BlockBuilder<? extends CifFileBuilder> builder)	A hook to make this instance aware of the data in all child nodes.
BlockBuilder<? extends CifFileBuilder>	enterBlock(String blockHeader)	Descend 1 level and enter a new Block.
CifFile	leaveFile()	Leave this builder instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rcsb.cif.model.CifFileBuilder

as

Constructor Details

CifFileBuilderImpl

public CifFileBuilderImpl()

Method Details

enterBlock

public BlockBuilder<? extends CifFileBuilder> enterBlock(String blockHeader)

Description copied from interface: CifFileBuilder

Descend 1 level and enter a new Block.

Specified by:

enterBlock in interface CifFileBuilder

Parameters:

blockHeader - the name for this block (usually the structure ID)

Returns:

a parent-aware builder instance at block level

digest

public void digest(BlockBuilder<? extends CifFileBuilder> builder)

Description copied from interface: CifFileBuilder

A hook to make this instance aware of the data in all child nodes.

Specified by:

digest in interface CifFileBuilder

Parameters:

builder - the child builder to digest

leaveFile

public CifFile leaveFile()

Description copied from interface: CifFileBuilder

Leave this builder instance. As this is the top-level and no parent exists, return the finished CifFile instance.

Specified by:

leaveFile in interface CifFileBuilder

Returns:

a CifFile instance

build

public CifFile build()

Description copied from interface: CifFileBuilder

Build the file described by this builder.

Specified by:

build in interface CifFileBuilder

Returns:

a CifFile instance

addBlock

public CifFileBuilder addBlock(Block block)

Description copied from interface: CifFileBuilder

Add a block to this builder.

Specified by:

addBlock in interface CifFileBuilder

Parameters:

block - some block with data

Returns:

this builder instance