Fix javadocs
This commit is contained in:
parent
4cbfc8a812
commit
2cf1f22b13
@ -13,6 +13,7 @@ public abstract class AbstractUnregisterEvent extends CustomEvent {
|
|||||||
* Constructor for a player that has unregistered himself.
|
* Constructor for a player that has unregistered himself.
|
||||||
*
|
*
|
||||||
* @param player the player
|
* @param player the player
|
||||||
|
* @param isAsync if the event is called asynchronously
|
||||||
*/
|
*/
|
||||||
public AbstractUnregisterEvent(Player player, boolean isAsync) {
|
public AbstractUnregisterEvent(Player player, boolean isAsync) {
|
||||||
super(isAsync);
|
super(isAsync);
|
||||||
|
|||||||
@ -16,6 +16,7 @@ public class FailedLoginEvent extends CustomEvent {
|
|||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param player The player
|
* @param player The player
|
||||||
|
* @param isAsync if the event is called asynchronously
|
||||||
*/
|
*/
|
||||||
public FailedLoginEvent(Player player, boolean isAsync) {
|
public FailedLoginEvent(Player player, boolean isAsync) {
|
||||||
super(isAsync);
|
super(isAsync);
|
||||||
|
|||||||
@ -14,6 +14,7 @@ public class UnregisterByPlayerEvent extends AbstractUnregisterEvent {
|
|||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param player the player (never null)
|
* @param player the player (never null)
|
||||||
|
* @param isAsync if the event is called asynchronously
|
||||||
*/
|
*/
|
||||||
public UnregisterByPlayerEvent(Player player, boolean isAsync) {
|
public UnregisterByPlayerEvent(Player player, boolean isAsync) {
|
||||||
super(player, isAsync);
|
super(player, isAsync);
|
||||||
|
|||||||
@ -66,6 +66,7 @@ public class OnJoinVerifier implements Reloadable {
|
|||||||
*
|
*
|
||||||
* @param player the player
|
* @param player the player
|
||||||
* @param isAuthAvailable whether or not the player is registered
|
* @param isAuthAvailable whether or not the player is registered
|
||||||
|
* @throws FailedVerificationException if the verification fails
|
||||||
*/
|
*/
|
||||||
public void checkAntibot(Player player, boolean isAuthAvailable) throws FailedVerificationException {
|
public void checkAntibot(Player player, boolean isAuthAvailable) throws FailedVerificationException {
|
||||||
if (isAuthAvailable || permissionsManager.hasPermission(player, PlayerStatePermission.BYPASS_ANTIBOT)) {
|
if (isAuthAvailable || permissionsManager.hasPermission(player, PlayerStatePermission.BYPASS_ANTIBOT)) {
|
||||||
@ -81,6 +82,7 @@ public class OnJoinVerifier implements Reloadable {
|
|||||||
* Checks whether non-registered players should be kicked, and if so, whether the player should be kicked.
|
* Checks whether non-registered players should be kicked, and if so, whether the player should be kicked.
|
||||||
*
|
*
|
||||||
* @param isAuthAvailable whether or not the player is registered
|
* @param isAuthAvailable whether or not the player is registered
|
||||||
|
* @throws FailedVerificationException if the verification fails
|
||||||
*/
|
*/
|
||||||
public void checkKickNonRegistered(boolean isAuthAvailable) throws FailedVerificationException {
|
public void checkKickNonRegistered(boolean isAuthAvailable) throws FailedVerificationException {
|
||||||
if (!isAuthAvailable && settings.getProperty(RestrictionSettings.KICK_NON_REGISTERED)) {
|
if (!isAuthAvailable && settings.getProperty(RestrictionSettings.KICK_NON_REGISTERED)) {
|
||||||
@ -92,6 +94,7 @@ public class OnJoinVerifier implements Reloadable {
|
|||||||
* Checks that the name adheres to the configured username restrictions.
|
* Checks that the name adheres to the configured username restrictions.
|
||||||
*
|
*
|
||||||
* @param name the name to verify
|
* @param name the name to verify
|
||||||
|
* @throws FailedVerificationException if the verification fails
|
||||||
*/
|
*/
|
||||||
public void checkIsValidName(String name) throws FailedVerificationException {
|
public void checkIsValidName(String name) throws FailedVerificationException {
|
||||||
if (name.length() > settings.getProperty(RestrictionSettings.MAX_NICKNAME_LENGTH)
|
if (name.length() > settings.getProperty(RestrictionSettings.MAX_NICKNAME_LENGTH)
|
||||||
@ -147,6 +150,7 @@ public class OnJoinVerifier implements Reloadable {
|
|||||||
*
|
*
|
||||||
* @param player the player to verify
|
* @param player the player to verify
|
||||||
* @param auth the auth object associated with the player
|
* @param auth the auth object associated with the player
|
||||||
|
* @throws FailedVerificationException if the verification fails
|
||||||
*/
|
*/
|
||||||
public void checkNameCasing(Player player, PlayerAuth auth) throws FailedVerificationException {
|
public void checkNameCasing(Player player, PlayerAuth auth) throws FailedVerificationException {
|
||||||
if (auth != null && settings.getProperty(RegistrationSettings.PREVENT_OTHER_CASE)) {
|
if (auth != null && settings.getProperty(RegistrationSettings.PREVENT_OTHER_CASE)) {
|
||||||
@ -166,6 +170,7 @@ public class OnJoinVerifier implements Reloadable {
|
|||||||
*
|
*
|
||||||
* @param isAuthAvailable whether or not the user is registered
|
* @param isAuthAvailable whether or not the user is registered
|
||||||
* @param playerIp the ip address of the player
|
* @param playerIp the ip address of the player
|
||||||
|
* @throws FailedVerificationException if the verification fails
|
||||||
*/
|
*/
|
||||||
public void checkPlayerCountry(boolean isAuthAvailable,
|
public void checkPlayerCountry(boolean isAuthAvailable,
|
||||||
String playerIp) throws FailedVerificationException {
|
String playerIp) throws FailedVerificationException {
|
||||||
@ -181,6 +186,7 @@ public class OnJoinVerifier implements Reloadable {
|
|||||||
* connection if so configured.
|
* connection if so configured.
|
||||||
*
|
*
|
||||||
* @param name the player name to check
|
* @param name the player name to check
|
||||||
|
* @throws FailedVerificationException if the verification fails
|
||||||
*/
|
*/
|
||||||
public void checkSingleSession(String name) throws FailedVerificationException {
|
public void checkSingleSession(String name) throws FailedVerificationException {
|
||||||
if (!settings.getProperty(RestrictionSettings.FORCE_SINGLE_SESSION)) {
|
if (!settings.getProperty(RestrictionSettings.FORCE_SINGLE_SESSION)) {
|
||||||
|
|||||||
@ -45,6 +45,7 @@ public class SendMailSsl {
|
|||||||
*
|
*
|
||||||
* @param emailAddress the email address the email is destined for
|
* @param emailAddress the email address the email is destined for
|
||||||
* @return the created HtmlEmail object
|
* @return the created HtmlEmail object
|
||||||
|
* @throws EmailException if the mail is invalid
|
||||||
*/
|
*/
|
||||||
public HtmlEmail initializeMail(String emailAddress) throws EmailException {
|
public HtmlEmail initializeMail(String emailAddress) throws EmailException {
|
||||||
String senderMail = StringUtils.isEmpty(settings.getProperty(EmailSettings.MAIL_ADDRESS))
|
String senderMail = StringUtils.isEmpty(settings.getProperty(EmailSettings.MAIL_ADDRESS))
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user