org.rcsb.cif.schema.SchemaProvider Maven / Gradle / Ivy

package org.rcsb.cif.schema;

import org.rcsb.cif.SchemaMismatchException;
import org.rcsb.cif.model.CifFile;
import org.rcsb.cif.model.CifFileBuilder;

/**
 * A SchemaProvides wraps {@link CifFile} and {@link CifFileBuilder} instances in their schema-aware subclass.
 * @param  the type of files returned
 * @param  the type of builder instances returned
 */
public interface SchemaProvider {
    /**
     * Wrap a {@link CifFile} in a schema-supporting implementation of the data model.
     * @param cifFile the generic file
     * @return a schema-aware cif file instance
     */
    F createTypedFile(CifFile cifFile);

    /**
     * Create an instance of a schema-supporting builder.
     * @return a schema-aware builder instance
     */
    B createTypedBuilder();

    /**
     * Perform an optional check if the provided argument matches this schema.
     * @param cifFile the CifFile to check
     * @throws SchemaMismatchException if the argument fails this test
     */
    default void validate(CifFile cifFile) throws SchemaMismatchException {}
}