Skip to content
This repository has been archived by the owner on Aug 23, 2020. It is now read-only.

Document Persistence Provider #1157

Merged
merged 7 commits into from
Aug 15, 2019

Conversation

GalRogozinski
Copy link
Contributor

Description

Document Persistence Provider
Fixes #1118

Type of change

  • Documentation Fix

@@ -7,48 +7,190 @@
import java.util.Set;

/**
* Created by paul on 3/2/17 for iri.
* Abstracts access to the data persisitence layer.
* Will handle the initialization and connections to the storage.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what I think about the future tense, b/c it's an interface?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Pair<Indexable, Persistable> latest(Class<?> model, Class<?> indexModel) throws Exception;

/**
* Given 2 types of {@link Persistable} types that should be indexed with the same keys,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

too many "type"s

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Persistable get(Class<?> model, Indexable index) throws Exception;

/**
* Checks with a certain degree of certainity whether we have a value indexed at a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

too many "certain"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@GalRogozinski GalRogozinski added C-Docs E-Refactor Epic - Improving code readability and maintainability E-Documentation Epic - Documentation of IRI C-Persistence and removed E-Refactor Epic - Improving code readability and maintainability labels Nov 19, 2018
alon-e and others added 3 commits February 27, 2019 17:33
Co-Authored-By: GalRogozinski <galrogogit@gmail.com>
# Conflicts:
#	src/main/java/com/iota/iri/storage/PersistenceProvider.java
#	src/main/java/com/iota/iri/storage/Tangle.java
@GalRogozinski
Copy link
Contributor Author

@jakubcech
Review when you are available please, and merge if you are fine with the changes

@GalRogozinski GalRogozinski merged commit 5499d34 into iotaledger:dev Aug 15, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Storage - tangle interface code documentation
3 participants