Skip to content

Amend Javadocs #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 15, 2018
Merged

Amend Javadocs #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions src/main/java/org/jenkinsci/plugins/workflow/flow/StashManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,13 +291,15 @@ public boolean shouldClearAll(@Nonnull Run<?,?> build) {

/**
* Mixin interface for an {@link ArtifactManager} which supports specialized stash behavior as well.
* <p>The recommended standard implementation is {@code JCloudsArtifactManager}
* in the plugin currently named {@code artifact-manager-s3}.
* This in turn supports extensibility to various cloud providers,
* and handles all aspects of making cloud artifact storage work smoothly in Jenkins
* including the {@link VirtualFile} implementation, robust network error handling,
* overall configuration UI, and more.
* Implement this interface directly at your own risk.
*
* <p> When implementing off-Jenkins artifact storage, you should NOT extend this directly but instead use the
* {@code JCloudsArtifactManager} in the plugin currently named {@code artifact-manager-s3}.
*
* This is dangerous to directly extend if using remote storage unless you write a very robust handling of network failures including at least a base timeout and retries.
* The {@code JCloudsArtifactManager} implementation supports extensibility to various cloud providers and custom stores via the {@code BlobStoreProvider} ExtensionPoint.
* It handles all aspects of making cloud artifact storage work smoothly in Jenkins
* including the {@link VirtualFile} implementation, robust network error handling, overall configuration UI, and more.
* <strong>Implement this interface directly at your own risk.</strong>
* @see <a href="https://github.com/jenkinsci/jep/blob/master/jep/202/README.adoc">JEP-202</a>
*/
@Restricted(Beta.class)
Expand Down