Skip to content

Commit a568c85

Browse files
jbertramtabish121
authored andcommitted
ARTEMIS-5817 improve management JavaDoc
1 parent 0812f20 commit a568c85

File tree

7 files changed

+334
-62
lines changed

7 files changed

+334
-62
lines changed

artemis-commons/src/main/java/org/apache/activemq/artemis/api/core/QueueConfiguration.java

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,15 @@ public Boolean isFqqn() {
717717

718718
/**
719719
* This method returns a JSON-formatted {@code String} representation of this {@code QueueConfiguration}. It is a
720-
* simple collection of key/value pairs. The keys used are referenced in {@link #set(String, String)}.
720+
* simple collection of key/value pairs. The keys used are referenced in {@link #set(String, String)}. For example:
721+
* <pre>
722+
* {
723+
* "name": "myQueue",
724+
* "address": "myAddress",
725+
* "routing-type": "ANYCAST",
726+
* "durable": true
727+
* }
728+
* </pre>
721729
*
722730
* @return a JSON-formatted {@code String} representation of this {@code QueueConfiguration}
723731
*/
@@ -826,7 +834,16 @@ public String toJSON() {
826834

827835
/**
828836
* This method returns a {@code QueueConfiguration} created from the JSON-formatted input {@code String}. The input
829-
* should be a simple object of key/value pairs. Valid keys are referenced in {@link #set(String, String)}.
837+
* should be a simple object of key/value pairs. Valid keys are referenced in {@link #set(String, String)}. For
838+
* example:
839+
* <pre>
840+
* {
841+
* "name": "myQueue",
842+
* "address": "myAddress",
843+
* "routing-type": "ANYCAST",
844+
* "durable": true
845+
* }
846+
* </pre>
830847
*
831848
* @return the {@code QueueConfiguration} created from the JSON-formatted input {@code String}
832849
*/

0 commit comments

Comments
 (0)