Skip to content

Commit 38800cd

Browse files
committed
Edit documentation
1 parent 5628962 commit 38800cd

14 files changed

+17
-18
lines changed

src/main/java/io/cdap/plugin/jms/sink/converters/RecordToBytesMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.jms.JMSException;
2626

2727
/**
28-
* A class with the functionality to convert StructuredRecords to BytesMessages
28+
* A class with the functionality to convert StructuredRecords to BytesMessages.
2929
*/
3030
public class RecordToBytesMessageConverter {
3131

src/main/java/io/cdap/plugin/jms/sink/converters/RecordToMapMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import javax.jms.MapMessage;
2424

2525
/**
26-
* A class with the functionality to convert StructuredRecords to MapMessages
26+
* A class with the functionality to convert StructuredRecords to MapMessages.
2727
*/
2828
public class RecordToMapMessageConverter {
2929

src/main/java/io/cdap/plugin/jms/sink/converters/RecordToMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import javax.jms.Message;
2424

2525
/**
26-
* A class with the functionality to convert StructuredRecords to Messages
26+
* A class with the functionality to convert StructuredRecords to Messages.
2727
*/
2828
public class RecordToMessageConverter {
2929

src/main/java/io/cdap/plugin/jms/sink/converters/RecordToObjectMessageConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.jms.ObjectMessage;
2626

2727
/**
28-
* A class with the functionality to convert StructuredRecords to ObjectMessages
28+
* A class with the functionality to convert StructuredRecords to ObjectMessages.
2929
*/
3030
public class RecordToObjectMessageConverter {
3131

src/main/java/io/cdap/plugin/jms/sink/converters/RecordToTextMessageConverter.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import javax.jms.TextMessage;
2626

2727
/**
28-
* A class with the functionality to convert StructuredRecords to TextMessages
28+
* A class with the functionality to convert StructuredRecords to TextMessages.
2929
*/
3030
public class RecordToTextMessageConverter {
3131

@@ -73,7 +73,7 @@ private static TextMessage convertRecordWithSingleField(TextMessage textMessage,
7373
* @return a JMS text message
7474
*/
7575
private static TextMessage convertRecordWithMultipleFields(TextMessage textMessage, StructuredRecord record) {
76-
String body = null;
76+
String body;
7777

7878
try {
7979
body = StructuredRecordStringConverter.toJsonString(record);

src/main/java/io/cdap/plugin/jms/sink/converters/SinkMessageConverterFacade.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import javax.jms.TextMessage;
3030

3131
/**
32-
* A facade class that provides the functionality to convert different type of JMS messages to structured records
32+
* A facade class that provides the functionality to convert different type of JMS messages to structured records.
3333
*/
3434
public class SinkMessageConverterFacade {
3535

src/main/java/io/cdap/plugin/jms/source/JMSStreamingSource.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333

3434
/**
3535
* This class <code>JMSStreamingSource</code> is a plugin that allows consuming messages from a specified JMS
36-
* Queue/Topic and generate
37-
* StructuredRecords out of them.
36+
* Queue/Topic and generate StructuredRecords out of them.
3837
*/
3938
@Plugin(type = StreamingSource.PLUGIN_TYPE)
4039
@Name("JMS")

src/main/java/io/cdap/plugin/jms/source/JMSStreamingSourceConfig.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
import javax.annotation.Nullable;
3838

3939
/**
40-
* Configs for {@link JMSStreamingSource}
40+
* Configs for {@link JMSStreamingSource}.
4141
*/
4242
public class JMSStreamingSourceConfig extends JMSConfig implements Serializable {
4343
// Params

src/main/java/io/cdap/plugin/jms/source/converters/BytesMessageToRecordConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
import javax.jms.MessageEOFException;
3535

3636
/**
37-
* A class with the functionality to convert BytesMessages to StructuredRecords
37+
* A class with the functionality to convert BytesMessages to StructuredRecords.
3838
*/
3939
public class BytesMessageToRecordConverter {
4040

src/main/java/io/cdap/plugin/jms/source/converters/MapMessageToRecordConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
import javax.jms.Message;
3434

3535
/**
36-
* A class with the functionality to convert MapMessages to StructuredRecords
36+
* A class with the functionality to convert MapMessages to StructuredRecords.
3737
*/
3838
public class MapMessageToRecordConverter {
3939

src/main/java/io/cdap/plugin/jms/source/converters/MessageToRecordConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import javax.jms.Message;
2828

2929
/**
30-
* A class with the functionality to convert Messages to StructuredRecords
30+
* A class with the functionality to convert Messages to StructuredRecords.
3131
*/
3232
public class MessageToRecordConverter {
3333

src/main/java/io/cdap/plugin/jms/source/converters/ObjectMessageToRecordConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import javax.jms.ObjectMessage;
3131

3232
/**
33-
* A class with the functionality to convert ObjectMessages to StructuredRecords
33+
* A class with the functionality to convert ObjectMessages to StructuredRecords.
3434
*/
3535
public class ObjectMessageToRecordConverter {
3636

src/main/java/io/cdap/plugin/jms/source/converters/SourceMessageConverterFacade.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import javax.jms.TextMessage;
1414

1515
/**
16-
* A facade class that provides a single method to convert JMS messages to structured records
16+
* A facade class that provides a single method to convert JMS messages to structured records.
1717
*/
1818
public class SourceMessageConverterFacade {
1919

@@ -23,12 +23,12 @@ public class SourceMessageConverterFacade {
2323
* @param message the incoming JMS message
2424
* @param config the {@link JMSStreamingSourceConfig} with all user provided property values
2525
* @return the {@link StructuredRecord} built out of the JMS message fields
26-
* @throws JMSException in case the method fails to read fields from the JMS message
26+
* @throws JMSException in case the method fails to read fields from the JMS message
2727
* @throws IllegalArgumentException in case the user provides a non-supported message type
2828
*/
2929
public static StructuredRecord toStructuredRecord(Message message, JMSStreamingSourceConfig config)
3030
throws JMSException, IllegalArgumentException {
31-
String messageType = null;
31+
String messageType;
3232
if (!Strings.isNullOrEmpty(config.getMessageType())) {
3333
messageType = config.getMessageType();
3434
} else {

src/main/java/io/cdap/plugin/jms/source/converters/TextMessageToRecordConverter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import javax.jms.TextMessage;
2828

2929
/**
30-
* A class with the functionality to convert TextMessages to StructuredRecords
30+
* A class with the functionality to convert TextMessages to StructuredRecords.
3131
*/
3232
public class TextMessageToRecordConverter {
3333

0 commit comments

Comments
 (0)