DOCSP-33345: Java comments pt. 8

source/includes/fundamentals/code-snippets/Monolight.java

@@ -1,5 +1,6 @@
 package fundamentals.monolightcodec;
 
+// Defines a custom class that contains fields describing a light
 // start class
 public class Monolight {
     private PowerStatus powerStatus = PowerStatus.OFF;

source/includes/fundamentals/code-snippets/MonolightCodec.java

@@ -8,6 +8,7 @@
 import org.bson.codecs.EncoderContext;
 import org.bson.codecs.configuration.CodecRegistry;
 
+// Implements the Codec interface by overriding the encode(), decode(), and getEncoderClass() methods
 // start class
 public class MonolightCodec implements Codec<Monolight>{
 
@@ -19,6 +20,7 @@ public MonolightCodec(CodecRegistry registry) {
         this.integerCodec = registry.get(Integer.class);
     }
 
+    // Defines an encode() method to convert Monolight enum values to BSON values
     @Override
     public void encode(BsonWriter writer, Monolight value, EncoderContext encoderContext) {
         writer.writeStartDocument();
@@ -29,6 +31,7 @@ public void encode(BsonWriter writer, Monolight value, EncoderContext encoderCon
         writer.writeEndDocument();
     }
 
+    // Defines a decode() method to convert BSON values to Monolight enum values
     @Override
     public Monolight decode(BsonReader reader, DecoderContext decoderContext) {
         Monolight monolight = new Monolight();
@@ -49,6 +52,7 @@ public Monolight decode(BsonReader reader, DecoderContext decoderContext) {
         return monolight;
     }
 
+    // Returns an instance of the Monolight class, since Java cannot infer the class type
     @Override
     public Class<Monolight> getEncoderClass() {
         return Monolight.class;

source/includes/fundamentals/code-snippets/Query.java

@@ -50,36 +50,51 @@ public static void main(String [] args){
     }
 
     private void comparisonFilter(){
+        // Creates a filter to match documents that have a "qty" value over 7
         // begin comparisonFilter
         Bson filter = Filters.gt("qty", 7);
+
+        // Retrieves documents that match the filter and prints them as JSON
         collection.find(filter).forEach(doc -> System.out.println(doc.toJson()));
         // end comparisonFilter
     }
 
     private void logicalFilter(){
+        // Creates a filter to match documents that have a "qty" value less than or equal to 7 and a "color" value of "pink"
         // begin logicalFilter
         Bson filter = Filters.and(Filters.lte("qty", 5), Filters.ne("color", "pink"));
+
+        // Retrieves documents that match the filter and prints them as JSON
         collection.find(filter).forEach(doc -> System.out.println(doc.toJson()));
         // end logicalFilter
     }
 
     private void elementFilter(){
+        // Creates a filter to match documents that contain the "rating" field
         // begin elementFilter
         Bson filter = Filters.exists("rating");
+
+        // Retrieves documents that match the filter and prints them as JSON
         collection.find(filter).forEach(doc -> System.out.println(doc.toJson()));
         // end elementFilter
     }
 
     private void evaluationFilter(){
+        // Creates a filter to match documents that have a "color" value ending with the letter "k"
         // begin evaluationFilter
         Bson filter = Filters.regex("color", "k$");
+
+        // Retrieves documents that match the filter and prints them as JSON
         collection.find(filter).forEach(doc -> System.out.println(doc.toJson()));
         // end evaluationFilter
     }
 
     private void arrayFilter(){
+        // Creates a filter to match documents whose "vendor" values are an array of 3 elements
         // begin arrayFilter
         Bson filter = Filters.size("vendor", 3);
+
+        // Retrieves documents that match the filter and prints them as JSON
         collection.find(filter).forEach(doc -> System.out.println(doc.toJson()));
         // end arrayFilter
     }