DATAMONGO-625 - Polishing.

Introduce default interface methods where possible. Rename save(…) to store(…) to align with method naming. Reduce constructor visibility to avoid invalid API usage. Replace mutable object in builder with fields to avoid mutation of already built objects when reusing the builder.
Remove Options.chunked(…) factory method to avoid confusion with chunkSize method.

Reformat code, strip trailing whitespaces.

Original pull request: spring-projects#842.

Author: mp911de

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/GridFsObject.java

@@ -21,7 +21,7 @@
 import com.mongodb.client.gridfs.model.GridFSFile;
 
 /**
- * A common interface when dealing with GridFs items using Spring Data.o
+ * A common interface when dealing with GridFs items using Spring Data.
  *
  * @author Christoph Strobl
  * @since 3.0
@@ -31,42 +31,43 @@ public interface GridFsObject<ID, CONTENT> {
 	/**
 	 * The {@link GridFSFile#getId()} value converted into its simple java type. <br />
 	 * A {@link org.bson.BsonString} will be converted to plain {@link String}.
-	 * 
+	 *
 	 * @return can be {@literal null} depending on the implementation.
 	 */
 	@Nullable
 	ID getFileId();
 
 	/**
 	 * The filename.
-	 * 
+	 *
 	 * @return
 	 */
 	String getFilename();
 
 	/**
 	 * The actual file content.
-	 * 
+	 *
 	 * @return
+	 * @throws IllegalStateException if the content cannot be obtained.
 	 */
 	CONTENT getContent();
 
 	/**
 	 * Additional information like file metadata (eg. contentType).
-	 * 
+	 *
 	 * @return never {@literal null}.
 	 */
 	Options getOptions();
 
 	/**
 	 * Additional, context relevant information.
-	 * 
+	 *
 	 * @author Christoph Strobl
 	 */
 	class Options {
 
-		private Document metadata = new Document();
-		private int chunkSize = -1;
+		private final Document metadata;
+		private final int chunkSize;
 
 		private Options(Document metadata, int chunkSize) {
 
@@ -83,16 +84,6 @@ public static Options none() {
 			return new Options(new Document(), -1);
 		}
 
-		/**
-		 * Static factory method to create {@link Options} with given chunk size.
-		 *
-		 * @param chunkSize
-		 * @return new instance of {@link Options}.
-		 */
-		public static Options chunked(int chunkSize) {
-			return new Options(new Document(), chunkSize);
-		}
-
 		/**
 		 * Static factory method to create {@link Options} with given content type.
 		 *
@@ -115,7 +106,7 @@ public static Options from(@Nullable GridFSFile gridFSFile) {
 
 		/**
 		 * Set the associated content type.
-		 * 
+		 *
 		 * @param contentType must not be {@literal null}.
 		 * @return new instance of {@link Options}.
 		 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/GridFsOperations.java

@@ -59,7 +59,9 @@ default ObjectId store(InputStream content, String filename) {
 	 * @param metadata can be {@literal null}.
 	 * @return the {@link ObjectId} of the {@link com.mongodb.client.gridfs.model.GridFSFile} just created.
 	 */
-	ObjectId store(InputStream content, @Nullable Object metadata);
+	default ObjectId store(InputStream content, @Nullable Object metadata) {
+		return store(content, null, metadata);
+	}
 
 	/**
 	 * Stores the given content into a file with the given name.
@@ -80,7 +82,9 @@ default ObjectId store(InputStream content, @Nullable Document metadata) {
 	 * @param contentType can be {@literal null}.
 	 * @return the {@link ObjectId} of the {@link com.mongodb.client.gridfs.model.GridFSFile} just created.
 	 */
-	ObjectId store(InputStream content, @Nullable String filename, @Nullable String contentType);
+	default ObjectId store(InputStream content, @Nullable String filename, @Nullable String contentType) {
+		return store(content, filename, contentType, null);
+	}
 
 	/**
 	 * Stores the given content into a file with the given name using the given metadata. The metadata object will be
@@ -91,7 +95,9 @@ default ObjectId store(InputStream content, @Nullable Document metadata) {
 	 * @param metadata can be {@literal null}.
 	 * @return the {@link ObjectId} of the {@link com.mongodb.client.gridfs.model.GridFSFile} just created.
 	 */
-	ObjectId store(InputStream content, @Nullable String filename, @Nullable Object metadata);
+	default ObjectId store(InputStream content, @Nullable String filename, @Nullable Object metadata) {
+		return store(content, filename, null, metadata);
+	}
 
 	/**
 	 * Stores the given content into a file with the given name and content type using the given metadata. The metadata
@@ -141,21 +147,21 @@ default ObjectId store(InputStream content, @Nullable String filename, @Nullable
 			uploadBuilder.metadata(metadata);
 		}
 
-		return save(uploadBuilder.build());
+		return store(uploadBuilder.build());
 	}
 
 	/**
 	 * Stores the given {@link GridFsObject}, likely a {@link GridFsUpload}, into into a file with given
 	 * {@link GridFsObject#getFilename() name}. If the {@link GridFsObject#getFileId()} is set, the file will be stored
 	 * with that id, otherwise the server auto creates a new id. <br />
-	 * 
+	 *
 	 * @param upload the {@link GridFsObject} (most likely a {@link GridFsUpload}) to be stored.
 	 * @param <T> id type of the underlying {@link com.mongodb.client.gridfs.model.GridFSFile}
 	 * @return the id of the stored file. Either an auto created value or {@link GridFsObject#getFileId()}, but never
 	 *         {@literal null}.
 	 * @since 3.0
 	 */
-	<T> T save(GridFsObject<T, InputStream> upload);
+	<T> T store(GridFsObject<T, InputStream> upload);
 
 	/**
 	 * Returns all files matching the given query. Note, that currently {@link Sort} criterias defined at the

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/GridFsTemplate.java

@@ -87,31 +87,6 @@ public GridFsTemplate(MongoDatabaseFactory dbFactory, MongoConverter converter,
 		this.bucket = bucket;
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.Object)
-	 */
-	@Override
-	public ObjectId store(InputStream content, @Nullable Object metadata) {
-		return store(content, null, metadata);
-	}
-
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, java.lang.String)
-	 */
-	public ObjectId store(InputStream content, @Nullable String filename, @Nullable String contentType) {
-		return store(content, filename, contentType, (Object) null);
-	}
-
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, java.lang.Object)
-	 */
-	public ObjectId store(InputStream content, @Nullable String filename, @Nullable Object metadata) {
-		return store(content, filename, null, metadata);
-	}
-
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.gridfs.GridFsOperations#store(java.io.InputStream, java.lang.String, java.lang.String, java.lang.Object)
@@ -125,7 +100,7 @@ public ObjectId store(InputStream content, @Nullable String filename, @Nullable
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.gridfs.GridFsOperations#save(org.springframework.data.mongodb.gridfs.GridFsObject)
 	 */
-	public <T> T save(GridFsObject<T, InputStream> upload) {
+	public <T> T store(GridFsObject<T, InputStream> upload) {
 
 		GridFSUploadOptions uploadOptions = computeUploadOptionsFor(upload.getOptions().getContentType(),
 				upload.getOptions().getMetadata());