Skip to content

Commit a0369d4

Browse files
fix javadoc
1 parent 17c1e9c commit a0369d4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

service/src/main/java/io/github/sergejsvisockis/documentservice/service/BaseDocumentWriteService.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88
import java.util.UUID;
99

1010
/**
11-
* This class is a base documentAsBytes processing implementation.
11+
* This class is a base document processing implementation.
1212
* Each method is to be implemented by each entity since that is possible
1313
* that some of them might be saved into the AWS S3, some into the SFT and some others into one another storage.
14-
* This is why an implementation myst be as generic as possible.
14+
* The same comes towards the document type some entities might require PDF while others DOCX for example.
15+
* This is why an implementation has to be as generic as possible.
1516
*
1617
* @param <T> the request body coming out of the REST service.
1718
*/
@@ -42,12 +43,11 @@ public SentDocumentMetadata process(T request) {
4243
public abstract T validate(T request);
4344

4445
/**
45-
* Supposed to generate PDF documentAsBytes which is supposed to be saved into some sort of storage later on.
46+
* Supposed to generate a document which is supposed to be saved into some sort of storage later on.
4647
*
4748
* @param request the request containing the documentAsBytes metadata to insert into the predefined template.
4849
* Generator could be any 3rd party subsystem.
49-
* @return Since PDF is being generated by the 3rd party system via the REST interface is supposed
50-
* to abstract the file itself.
50+
* @return generated document metadata.
5151
*/
5252
public abstract G generate(T request);
5353

0 commit comments

Comments
 (0)