Package org.testingisdocumenting.znai.enterprise.storage

Class FileBasedDocumentationStorage

java.lang.Object

org.testingisdocumenting.znai.enterprise.storage.FileBasedDocumentationStorage

All Implemented Interfaces:

DocumentationStorage

public class FileBasedDocumentationStorage
extends java.lang.Object
implements DocumentationStorage

Constructor Summary

Constructors

Constructor	Description
FileBasedDocumentationStorage(java.nio.file.Path storageRoot, java.nio.file.Path docsRootPath)

Method Summary

Modifier and Type	Method	Description
boolean	contains(java.lang.String docId)
long	lastUpdateTime(java.lang.String docId, java.lang.String version)
java.util.List<org.testingisdocumenting.znai.structure.DocMeta>	list()
void	prepare(java.lang.String docId, java.lang.String version, org.testingisdocumenting.znai.server.docpreparation.DocumentationPreparationProgress progress)
void	remove(java.lang.String actor, java.lang.String docId)
void	store(java.lang.String actor, java.lang.String docId, java.lang.String version, java.nio.file.Path generatedDocumentation)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedDocumentationStorage

public FileBasedDocumentationStorage(java.nio.file.Path storageRoot,
                                     java.nio.file.Path docsRootPath)

Method Detail

contains

public boolean contains(java.lang.String docId)

Specified by:

contains in interface DocumentationStorage

store

public void store(java.lang.String actor,
                  java.lang.String docId,
                  java.lang.String version,
                  java.nio.file.Path generatedDocumentation)

Specified by:

store in interface DocumentationStorage

prepare

public void prepare(java.lang.String docId,
                    java.lang.String version,
                    org.testingisdocumenting.znai.server.docpreparation.DocumentationPreparationProgress progress)

Specified by:

prepare in interface DocumentationStorage

lastUpdateTime

public long lastUpdateTime(java.lang.String docId,
                           java.lang.String version)

Specified by:

lastUpdateTime in interface DocumentationStorage

remove

public void remove(java.lang.String actor,
                   java.lang.String docId)

Specified by:

remove in interface DocumentationStorage

list

public java.util.List<org.testingisdocumenting.znai.structure.DocMeta> list()

Specified by:

list in interface DocumentationStorage