org.getcraftdone.gradle.internal.snapshot

Interface ModelSnapshot

public interface ModelSnapshot

Snapshot of the model information that we are interested in documenting.

Method Summary

Modifier and Type	Method and Description
ModelSnapshot	minus(ModelSnapshot other) Creates new snapshot that is a result of subtraction of 'this' and 'other' snapshot.
ModelSnapshot	take(org.gradle.api.Plugin plugin, org.gradle.api.Project project) Creates new snapshot
java.lang.String	toHtml() Describes the snapshot in human readable way (html format)
java.lang.String	toMarkdown() Describes the snapshot in human readable way (markdown format)

Method Detail

take

ModelSnapshot take(org.gradle.api.Plugin plugin,
                   org.gradle.api.Project project)

Creates new snapshot

minus

ModelSnapshot minus(ModelSnapshot other)

Creates new snapshot that is a result of subtraction of 'this' and 'other' snapshot. Required to correctly calculate the delta of changes a plugin applies to the project.

toMarkdown

java.lang.String toMarkdown()

Describes the snapshot in human readable way (markdown format)

toHtml

java.lang.String toHtml()

Describes the snapshot in human readable way (html format)