Upstream/Minestom
1
0
Fork 0
mirror of https://github.com/Minestom/Minestom.git synced 2024-06-26 06:24:54 +02:00
Code Issues Projects Releases Wiki Activity

Added constructor comments in ColoredText and RichMessage

Browse Source
This commit is contained in:
themode 2020-10-22 09:10:14 +02:00
parent f72dce3a46
commit c7f8ae7536
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/net/minestom/server/chat/ColoredText.java
View File

@ -21,6 +21,14 @@ public class ColoredText extends JsonMessage {
// the raw text
private String message;
/**
* Creates a colored text.
* <p>
* You need to use one of the static methods instead of the constructor.
*
* @param message the content of the text
* @see #of(String) to create a colored text
*/
private ColoredText(String message) {
this.message = message;
refreshUpdate();

21
src/main/java/net/minestom/server/chat/RichMessage.java
View File

@ -24,11 +24,14 @@ public class RichMessage extends JsonMessage {
private List<RichComponent> components = new ArrayList<>();
private RichComponent currentComponent;
/**
* @see #of(ColoredText) to create a rich message
*/
private RichMessage() {
}
/**
* Create a RichMessage by adding the first rich component
* Creates a {@link RichMessage} by adding the first rich component.
*
* @param coloredText the text composing the first rich component
* @return the created rich message object
@ -49,7 +52,7 @@ public class RichMessage extends JsonMessage {
}
/**
* Set the click event of the current rich component
* Sets the click event of the current rich component.
*
* @param clickEvent the click event to set
* @return the rich message
@ -62,7 +65,7 @@ public class RichMessage extends JsonMessage {
}
/**
* Set the hover event of the current rich component
* Sets the hover event of the current rich component.
*
* @param hoverEvent the hover event to set
* @return the rich message
@ -75,7 +78,7 @@ public class RichMessage extends JsonMessage {
}
/**
* Set the insertion string of the current rich component
* Sets the insertion string of the current rich component.
*
* @param insertion the string to insert in the chat box
* @return the rich message
@ -88,7 +91,7 @@ public class RichMessage extends JsonMessage {
}
/**
* Add a new rich component to the message
* Adds a new rich component to the message.
*
* @param coloredText the text composing the rich component
* @param formatRetention the format retention of the added component
@ -102,8 +105,8 @@ public class RichMessage extends JsonMessage {
}
/**
* Add a new rich component to the message,
* the format retention is set to {@link FormatRetention#ALL}
* Adds a new rich component to the message,
* the format retention is set to {@link FormatRetention#ALL}.
*
* @param coloredText the text composing the rich component
* @return the rich message
@ -146,7 +149,7 @@ public class RichMessage extends JsonMessage {
}
/**
* Process the components to add click/hover events
* Processes the components to add click/hover events.
*
* @param component the rich component to process
* @return a list of processed components
@ -207,7 +210,7 @@ public class RichMessage extends JsonMessage {
}
/**
* Represents a colored text with a click and hover event (can be null).
* Represents a {@link ColoredText} with a click and hover event (can be null).
*/
private static class RichComponent {