org.technologybrewery.fermenter.mda.element.ValidatedElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fermenter-mda Show documentation

The newest version!

package org.technologybrewery.fermenter.mda.element;

import java.io.IOException;
import java.net.URL;
import java.util.Enumeration;

import org.technologybrewery.fermenter.mda.generator.GenerationException;

import com.fasterxml.jackson.annotation.JsonIgnore;

/**
 * Defines the contract and common functionality classes that represent json and can be validated by a json schema.
 */
public interface ValidatedElement {

    /**
     * Returns a URL to the schema that can be used to validate json files for the implementing sub-class.
     * 
     * @return URL to a json schema
     */
    @JsonIgnore
    public default URL getJsonSchemaUrl() {
        Enumeration jsonSchema;
        String schemaFileName = getSchemaFileName();
        try {
            jsonSchema = Target.class.getClassLoader().getResources(schemaFileName);

        } catch (IOException e) {
            throw new GenerationException("Could not find Fermenter json schema for '" + schemaFileName + "'!", e);
        }

        return jsonSchema.nextElement();

    }

    /**
     * The name of the schema file used to validate a sub-class (e.g., foo-schema.json).
     * 
     * @return schema name
     */
    @JsonIgnore
    public String getSchemaFileName();

}