Package io.jenkins.plugins.asyntai

Class KnowledgeSync

java.lang.Object

io.jenkins.plugins.asyntai.KnowledgeSync

public final class KnowledgeSync
extends Object

Compares documentation files with the knowledge base and sends the difference. Has no Jenkins dependency, so the rules are easy to test.

The entry title is the file path with the title prefix in front. The next run finds the entry again by that title.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KnowledgeSync.Options	Settings for one run.
static final class	KnowledgeSync.Result	Counts and rows of one run.
static final class	KnowledgeSync.Row	One line of the build summary.
static final class	KnowledgeSync.SourceFile	One file to send: its path relative to the root folder, and its raw text.

Method Summary

Modifier and Type	Method	Description
static KnowledgeSync.Result	run(List<KnowledgeSync.SourceFile> files, KnowledgeApi api, KnowledgeSync.Options options, PrintStream log)	Runs the sync.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

run

public static KnowledgeSync.Result run(List<KnowledgeSync.SourceFile> files,
 KnowledgeApi api,
 KnowledgeSync.Options options,
 PrintStream log)
                                throws ApiException

Runs the sync.

Throws:

ApiException - when the knowledge base cannot be read at all