com.reprezen.genflow.api.trace.package-info Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright © 2013, 2016 Modelsolv, Inc.
 * All Rights Reserved.
 *
 * NOTICE: All information contained herein is, and remains the property
 * of ModelSolv, Inc. See the file license.html in the root directory of
 * this project for further information.
 *******************************************************************************/
/**
 * Trace facilities for CodeGen.
 * 
 * Trace is the means by which a GenTemplate leaves a trail of evidence for the
 * output it has generated. For each piece of output, trace items can describe
 * the contributing sources and the role played by each. In both cases (outputs
 * and sources), the trace items can incorporate locators (see
 * {@link com.reprezen.genflow.api.source.ILocator}) to identify logical
 * portions of actual source or output files. We call such portions "output
 * items" and "source items."
 * 

 * Classes include:
 * 

 * {@link GenTemplateTrace}
 * The collection of trace information created by a GenTemplate
 * execution.
 * {@link GenTemplateTraceItem}
 * Trace information relating to a single output item, possibly with
 * multiple associated source items.
 * {@link TenTemplateTraceSourceItem}
 * Describes a single source item attached to a trace item, and its role in
 * the creatino of the associated output item.
 * {@link GenTemlpateTraceBuilder}
 * Offers a fluent API for constructing trace items and adding them to a
 * trace
 * {@link GenTargetTraces}
 * Manages a set of named traces. Traces are generally named for the
 * GenTargets whose executions produced them.
 * {@link GenTemplateTraceSerializer}
 * Supports transferring traces to and from external files, using JSON
 * structures
 * {@link GenTemplateTraceUtils}
 * Provides methods to search traces for items and source items meeting
 * specific criteria
 * 
 * 
 * @author Andy
 *
 */
package com.reprezen.genflow.api.trace;