OCD fixes

Author: Aaron1011

src/main/java/org/spongepowered/api/effect/Viewer.java

@@ -33,7 +33,8 @@
 
 /**
  * A Viewer is something that sees effects.
- * The Viewer class contains methods for spawning particles and playing sound effects.
+ * The Viewer class contains methods for spawning particles and playing sound
+ * effects.
  */
 public interface Viewer {
 
@@ -76,7 +77,8 @@ public interface Viewer {
      * @param sound The sound to play
      * @param position The position to play the sound
      * @param volume The volume to play the sound at, usually between 0 and 2
-     * @param pitch The modulation of the sound to play at, usually between 0 and 2
+     * @param pitch The modulation of the sound to play at, usually between 0
+     *        and 2
      */
     void playSound(SoundType sound, Vector3d position, double volume, double pitch);
 
@@ -87,8 +89,10 @@ public interface Viewer {
      * @param sound The sound to play
      * @param position The position to play the sound
      * @param volume The volume to play the sound at, usually between 0 and 2
-     * @param pitch The modulation of the sound to play at, usually between 0 and 2
-     * @param minVolume The minimum volume to play the sound at, usually between 0 and 2
+     * @param pitch The modulation of the sound to play at, usually between 0
+     *        and 2
+     * @param minVolume The minimum volume to play the sound at, usually between
+     *        0 and 2
      */
     void playSound(SoundType sound, Vector3d position, double volume, double pitch, double minVolume);
 

src/main/java/org/spongepowered/api/effect/particle/ItemParticle.java

@@ -28,7 +28,8 @@
 import org.spongepowered.api.item.inventory.ItemStackSnapshot;
 
 /**
- * Represents a particle effect that needs a item stack to be rendered on the client.
+ * Represents a particle effect that needs a item stack to be rendered on the
+ * client.
  */
 public interface ItemParticle extends ParticleEffect {
 

src/main/java/org/spongepowered/api/plugin/Plugin.java

@@ -63,8 +63,10 @@
     /**
      * A simple dependency string for this mod separated by a ";"
      * example:
-     * <pre>"required-after:Sponge@[1.2.3.2222,);required-after:myLibraryPlugin;after:towny;before:worldguard"</pre>
-     * supported options:
+     * <pre>"required-after:Sponge@[1.2.3.2222,);
+     * required-after:myLibraryPlugin;after:towny;before:worldguard"</pre>
+     *
+     * <p>supported options:
      * <dl>
      *   <dt>after</dt>
      *   <dd>when present this plugin will run after plugin x</dd>
@@ -75,7 +77,7 @@
      *   <dt>required-before</dt>
      *   <dd>plugin x must be present, load before plugin x</dd>
      * </dl>
-     * supports maven version ranges after @ in any field
+     * supports maven version ranges after @ in any field</p>
      *
      * @return The plugin dependencies
      */

src/main/java/org/spongepowered/api/service/ban/BanService.java

@@ -39,8 +39,8 @@
  * service API (e.g. writing them to a database). In essence, expired bans
  * should be treated the same as user-removed bans.
  *
- * For example, {@link #getBans()} would not include any expired bans,
- * and {@link #hasBan(Ban)} would return <code>false</code>.
+ * <p>For example, {@link #getBans()} would not include any expired bans,
+ * and {@link #hasBan(Ban)} would return <code>false</code>.</p>
  */
 public interface BanService {
 

src/main/java/org/spongepowered/api/service/economy/Currency.java

@@ -29,8 +29,10 @@
 import java.math.BigDecimal;
 
 /**
- * Represents a form of currency. At least one type of currency is always supported.
- * Depending on the provider of the {@link EconomyService}, more currencies may be available.
+ * Represents a form of currency. At least one type of currency is always
+ * supported.
+ *
+ * <p>Depending on the provider of the {@link EconomyService}, more currencies may be available.</p>
  */
 public interface Currency {
 
@@ -63,7 +65,7 @@ public interface Currency {
      *
      * <p>Should include the symbol if it is present</p>
      *
-     * @param amount to format
+     * @param amount The amount to format
      * @return String formatted amount
      */
     default Text format(BigDecimal amount) {
@@ -73,10 +75,10 @@ default Text format(BigDecimal amount) {
     /**
      * Formats the given amount using the specified number of fractional digits.
      *
-     *  <p>Should include the symbol if it is present</p>
+     * <p>Should include the symbol if it is present</p>
      *
-     * @param amount
-     * @param numFractionDigits
+     * @param amount The amount to format
+     * @param numFractionDigits The numer of fractional digits to use
      * @return String formatted amount.
      */
     Text format(BigDecimal amount, int numFractionDigits);

src/main/java/org/spongepowered/api/service/economy/EconomyService.java

@@ -58,11 +58,11 @@ public interface EconomyService extends ContextualService<Account> {
      * Returns the {@link Set} of supported {@link Currency} objects that are
      * implemented by this EconomyService.
      *
-     * <p>The economy service provider may only support one currency, in which case
-     * {@link #getDefaultCurrency()} will be the only member of the set.</p>
+     * <p>The economy service provider may only support one currency, in which
+     * case {@link #getDefaultCurrency()} will be the only member of the set.</p>
      *
-     * <p>The set returned is a read-only a view of all currencies available in the
-     * EconomyService.</p>
+     * <p>The set returned is a read-only a view of all currencies available in
+     * the EconomyService.</p>
      *
      * @return The {@link Set} of all {@link Currency}s
      */
@@ -76,6 +76,18 @@ public interface EconomyService extends ContextualService<Account> {
      */
     Optional<UniqueAccount> getAccount(UUID uuid);
 
+    /**
+     * Gets the {@link Account} with the specified identifier, if available.
+     *
+     * <p>The returned {@link Account} may be a {@link UniqueAccount} or
+     * a {@link VirtualAccount}, depending on the implementation.</p>
+     *
+     * @param identifier The identifier of the account to get
+     * @return The {@link VirtualAccount}, if available.
+     */
+    Optional<Account> getAccount(String identifier);
+
+
     /**
      * Attempts to create a {@link UniqueAccount} for the user with the specified {@link UUID}.
      *
@@ -90,17 +102,6 @@ public interface EconomyService extends ContextualService<Account> {
      */
     Optional<UniqueAccount> createAccount(UUID uuid);
 
-    /**
-     * Gets the {@link Account} with the specified identifier, if available.
-     *
-     * <p>The returned {@link Account} may be a {@link UniqueAccount} or
-     * a {@link VirtualAccount}, depending on the implementation.</p>
-     *
-     * @param identifier The identifier of the account to get
-     * @return The {@link VirtualAccount}, if available.
-     */
-    Optional<Account> getAccount(String identifier);
-
     /**
      * Attempts to create a {@link VirtualAccount} with the specified identifier
      *

src/main/java/org/spongepowered/api/service/economy/account/Account.java

@@ -24,11 +24,6 @@
  */
 package org.spongepowered.api.service.economy.account;
 
-import java.math.BigDecimal;
-import java.util.Map;
-import java.util.Set;
-import java.util.UUID;
-
 import org.spongepowered.api.entity.Entity;
 import org.spongepowered.api.entity.living.player.User;
 import org.spongepowered.api.event.cause.Cause;
@@ -41,16 +36,21 @@
 import org.spongepowered.api.service.economy.transaction.TransferResult;
 import org.spongepowered.api.text.Text;
 
+import java.math.BigDecimal;
+import java.util.Map;
+import java.util.Set;
+import java.util.UUID;
+
 /**
  * Represents an account, which stores amounts of various {@link Currency currencies}.
  *
  * <p>Accounts come in two varieties: {@link UniqueAccount user accounts} and {@link VirtualAccount} virtual accounts.
  *
  * Unique accounts are bound to a {@link UUID}, usually of a particular {@link User}'s {@link GameProfile}.
  *
- * Virtual accounts are identified by a String identifier, which may have any value. They are
- * not tied to any {@link Entity}, player or otherwise. Virtual accounts may be used for purposes
- * such as bank accounts, non-player {@link Entity} accounts, or other things.</p>
+ * Virtual accounts are identified by a String identifier, which may have any
+ * value. They are not tied to any {@link Entity}, player or otherwise. Virtual
+ * accounts may be used for purposes such as bank accounts, non-player {@link Entity} accounts, or other things.</p>
  */
 public interface Account extends Contextual {
 
@@ -116,8 +116,8 @@ default boolean hasBalance(Currency currency) {
      * Returns a {@link BigDecimal} representative of the balance stored within this
      * {@link Account} for the {@link Currency} given and the set of {@link Context}s.
      *
-     * <p>The default result when the account does not have a balance of the given
-     * {@link Currency} should be {@link BigDecimal#ZERO}.</p>
+     * <p>The default result when the account does not have a balance of the
+     * given {@link Currency} should be {@link BigDecimal#ZERO}.</p>
      *
      * <p>The balance may be unavailable depending on the set of {@link Context}s used.</p>
      *
@@ -132,8 +132,8 @@ default boolean hasBalance(Currency currency) {
      * Returns a {@link BigDecimal} representative of the balance stored within this
      * {@link Account} for the {@link Currency} given, with the current active contexts.
      *
-     * <p>The default result when the account does not have a balance of the given
-     * {@link Currency} will be {@link #getDefaultBalance(Currency)}.</p>
+     * <p>The default result when the account does not have a balance of the
+     * given {@link Currency} will be {@link #getDefaultBalance(Currency)}.</p>
      *
      * @param currency a {@link Currency} to check the balance of
      *
@@ -186,8 +186,8 @@ default Map<Currency, BigDecimal> getBalances() {
     }
 
     /**
-     * Sets the balance for this account to the specified amount for the specified
-     * {@link Currency}, with the specified set of {@link Context}s.
+     * Sets the balance for this account to the specified amount for
+     * the specified {@link Currency}, with the specified set of {@link Context}s.
      *
      * <p>Negative balances may or may not be supported depending on
      * the {@link Currency} specified and the implementation.</p>
@@ -202,8 +202,8 @@ default Map<Currency, BigDecimal> getBalances() {
     TransactionResult setBalance(Currency currency, BigDecimal amount, Cause cause, Set<Context> contexts);
 
     /**
-     * Sets the balance for this account to the specified amount for the specified
-     * {@link Currency}, with the current active {@link Context}s.
+     * Sets the balance for this account to the specified amount for the
+     * specified {@link Currency}, with the current active {@link Context}s.
      *
      * <p>Negative balances may or may not be supported depending on
      * the {@link Currency} specified and the implementation.</p>
@@ -229,8 +229,8 @@ default TransactionResult setBalance(Currency currency, BigDecimal amount, Cause
     TransactionResult resetBalances(Cause cause, Set<Context> contexts);
 
     /**
-     * Resets the balances for all {@link Currency}s used on this account to their
-     * default values ({@link #getDefaultBalance(Currency)}), using the current active {@link Context}
+     * Resets the balances for all {@link Currency}s used on this account to
+     * their default values ({@link #getDefaultBalance(Currency)}), using the current active {@link Context}.
      *
      * @param cause The {@link Cause} for the transaction
      *

src/main/java/org/spongepowered/api/service/economy/transaction/ResultType.java

@@ -32,7 +32,7 @@
 public enum ResultType {
 
     /**
-     * Transaction finished with no errors
+     * Transaction finished with no errors.
      */
     SUCCESS,
 
@@ -52,7 +52,8 @@ public enum ResultType {
     ACCOUNT_NO_FUNDS,
 
     /**
-     * The account would be put past it's maximum capacity, so the transaction failed.
+     * The account would be put past it's maximum capacity, so the transaction
+     * failed.
      */
     ACCOUNT_NO_SPACE
 }

src/main/java/org/spongepowered/api/service/economy/transaction/TransactionResult.java

@@ -67,13 +67,14 @@ public interface TransactionResult {
     Set<Context> getContexts();
 
     /**
-     * Get the {@link ResultType} of this transaction
+     * Get the {@link ResultType} of this transaction.
+     *
      * @return resultType
      */
     ResultType getResult();
 
     /**
-     * Returns the {@link TransactionType} of this result
+     * Returns the {@link TransactionType} of this result.
      *
      * @return type of Transaction
      */

src/main/java/org/spongepowered/api/service/whitelist/WhitelistService.java

@@ -46,26 +46,30 @@ public interface WhitelistService {
     Collection<GameProfile> getWhitelistedProfiles();
 
     /**
-     * Gets whether the specified {@link GameProfile} is present on this whitelist.
+     * Gets whether the specified {@link GameProfile} is present on this
+     * whitelist.
      *
      * @param profile The game profile to check for
-     * @return Whether the specified {@link GameProfile} is present on this whitelist
+     * @return Whether the specified {@link GameProfile} is present on this
+     *         whitelist
      */
     boolean isWhitelisted(GameProfile profile);
 
     /**
      * Adds the specified {@link GameProfile} to this whitelist.
      *
      * @param profile The game profile to add
-     * @return Whether the specified {@link GameProfile} was already present on this whitelist
+     * @return Whether the specified {@link GameProfile} was already present on
+     *         this whitelist
      */
     boolean addProfile(GameProfile profile);
 
     /**
      * Removes the specified {@link GameProfile} from this whitelist, if present.
      *
      * @param profile The game profile to remove
-     * @return Whether the specified {@link GameProfile} was present before removal
+     * @return Whether the specified {@link GameProfile} was present before
+     *         removal
      */
     boolean removeProfile(GameProfile profile);
 }