dev.galasa.artifact.IArtifactManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.artifact.manager Show documentation

A Galasa project

There is a newer version: 0.38.0

Show newest version

/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.artifact;

import dev.galasa.artifact.ISkeletonProcessor.SkeletonType;

/**
 * This is a very simple manager which provides access to objects to assist in
 * retrieving artifacts/resources from the 'resources' directory in your test
 * bundle, and manipulating those resources
 * 
 * @author James Bartlett
 *
 */
public interface IArtifactManager {

    /**
     * Return an {@link IBundleResources} object to assist in retrieving artifacts
     * from within a bundles 'resources' directory.
     * 
     * @param owningClass - any class within the bundle to be accessed, simply used
     *                    as a reference to get hold of the correct bundle
     * @return {@link IBundleResources}
     */
    IBundleResources getBundleResources(Class owningClass);

    /**
     * Return an {@link ISkeletonProcessor} object to perform substitutions on
     * skeleton files
     * 
     * @return {@link ISkeletonProcessor}
     */
    ISkeletonProcessor getSkeletonProcessor();

    /**
     * Return an {@link ISkeletonProcessor} object to perform substitutions on
     * skeleton files Select Type using {@link SkeletonType}
     * 
     * @param skeletonType
     * @return {@link ISkeletonProcessor}
     * @throws SkeletonProcessorException
     */
    ISkeletonProcessor getSkeletonProcessor(int skeletonType) throws SkeletonProcessorException;

}