Fix formatting in a bunch of files.

This commit is contained in:
md_5 2015-02-14 18:36:58 +11:00
parent 2055c98ebe
commit 61cee2d27c
14 changed files with 63 additions and 52 deletions

View File

@ -4,17 +4,18 @@ import net.md_5.bungee.api.chat.BaseComponent;
import net.md_5.bungee.api.connection.ProxiedPlayer; import net.md_5.bungee.api.connection.ProxiedPlayer;
/** /**
* Represents a configuration of a title. * Represents a configuration of a title. A title in Minecraft consists of a
* A title in Minecraft consists of a main title and a sub title. * main title and a sub title. It will {@link #fadeIn(int)}, {@link #stay(int)},
* It will {@link #fadeIn(int)}, {@link #stay(int)}, and {@link #fadeOut(int)} * and {@link #fadeOut(int)} for a specified amount of time. In most cases you
* for a specified amount of time. * will want to {@link #reset()} the current title first so your title won't be
* In most cases you will want to {@link #reset()} the current title first so * affected by a previous one.
* your title won't be affected by a previous one.
* <p> * <p>
* You can create a new configuration by calling {@link ProxyServer#createTitle()}. * You can create a new configuration by calling
* {@link ProxyServer#createTitle()}.
*/ */
public interface Title public interface Title
{ {
/** /**
* Set the title to send to the player. * Set the title to send to the player.
* *
@ -31,7 +32,6 @@ public interface Title
*/ */
public Title title(BaseComponent... text); public Title title(BaseComponent... text);
/** /**
* Set the subtitle to send to the player. * Set the subtitle to send to the player.
* *
@ -48,12 +48,11 @@ public interface Title
*/ */
public Title subTitle(BaseComponent... text); public Title subTitle(BaseComponent... text);
/** /**
* Set the duration in ticks of the fade in effect of the title. * Set the duration in ticks of the fade in effect of the title. Once this
* Once this period of time is over the title will stay for the amount * period of time is over the title will stay for the amount of time
* of time specified in {@link #stay(int)}. * specified in {@link #stay(int)}. The default value for the official
* The default value for the official Minecraft version is 20 (1 second). * Minecraft version is 20 (1 second).
* *
* @param ticks The amount of ticks (1/20 second) for the fade in effect. * @param ticks The amount of ticks (1/20 second) for the fade in effect.
* @return This title configuration. * @return This title configuration.
@ -62,9 +61,9 @@ public interface Title
/** /**
* Set the duration in ticks how long the title should stay on the screen. * Set the duration in ticks how long the title should stay on the screen.
* Once this period of time is over the title will fade out using the duration * Once this period of time is over the title will fade out using the
* specified in {@link #fadeOut(int)}. * duration specified in {@link #fadeOut(int)}. The default value for the
* The default value for the official Minecraft version is 60 (3 seconds). * official Minecraft version is 60 (3 seconds).
* *
* @param ticks The amount of ticks (1/20 second) for the fade in effect. * @param ticks The amount of ticks (1/20 second) for the fade in effect.
* @return This title configuration. * @return This title configuration.
@ -72,35 +71,33 @@ public interface Title
public Title stay(int ticks); public Title stay(int ticks);
/** /**
* Set the duration in ticks of the fade out effect of the title. * Set the duration in ticks of the fade out effect of the title. The
* The default value for the official Minecraft version is 20 (1 second). * default value for the official Minecraft version is 20 (1 second).
* *
* @param ticks The amount of ticks (1/20 second) for the fade out effect. * @param ticks The amount of ticks (1/20 second) for the fade out effect.
* @return This title configuration. * @return This title configuration.
*/ */
public Title fadeOut(int ticks); public Title fadeOut(int ticks);
/** /**
* Remove the currently displayed title from the player's screen. * Remove the currently displayed title from the player's screen. This will
* This will keep the currently used display times and will only remove the title. * keep the currently used display times and will only remove the title.
* *
* @return This title configuration. * @return This title configuration.
*/ */
public Title clear(); public Title clear();
/** /**
* Remove the currently displayed title from the player's screen * Remove the currently displayed title from the player's screen and set the
* and set the configuration back to the default values. * configuration back to the default values.
* *
* @return This title configuration. * @return This title configuration.
*/ */
public Title reset(); public Title reset();
/** /**
* Send this title configuration to the specified player. * Send this title configuration to the specified player. This is the same
* This is the same as calling {@link ProxiedPlayer#sendTitle(Title)}. * as calling {@link ProxiedPlayer#sendTitle(Title)}.
* *
* @param player The player to send the title to. * @param player The player to send the title to.
* @return This title configuration. * @return This title configuration.

View File

@ -175,14 +175,15 @@ public interface ProxiedPlayer extends Connection, CommandSender
/** /**
* Gets whether this player is using a FML client. * Gets whether this player is using a FML client.
* <p> * <p>
* This method is only reliable if BungeeCord links Minecraft 1.8 servers * This method is only reliable if BungeeCord links Minecraft 1.8 servers
* together, as Bungee can pick up whether a user is a Forge user with the * together, as Bungee can pick up whether a user is a Forge user with the
* initial handshake. If this is used for a 1.7 network, this might return * initial handshake. If this is used for a 1.7 network, this might return
* <code>false</code> even if the user is a FML user, as Bungee can only * <code>false</code> even if the user is a FML user, as Bungee can only
* determine this information if a handshake successfully completes. * determine this information if a handshake successfully completes.
* </p> * </p>
* @return <code>true</code> if it is known that the user is using a FML *
* client, <code>false</code> otherwise. * @return <code>true</code> if it is known that the user is using a FML
* client, <code>false</code> otherwise.
*/ */
boolean isForgeUser(); boolean isForgeUser();
@ -195,7 +196,7 @@ public interface ProxiedPlayer extends Connection, CommandSender
* <p> * <p>
* Consumers of this API should be aware that an empty mod list does * Consumers of this API should be aware that an empty mod list does
* <em>not</em> indicate that a user is not a Forge user, and so should not * <em>not</em> indicate that a user is not a Forge user, and so should not
* use this API to check for this. See the {@link #isForgeUser() * use this API to check for this. See the {@link #isForgeUser()
* isForgeUser} method instead. * isForgeUser} method instead.
* </p> * </p>
* <p> * <p>
@ -204,7 +205,7 @@ public interface ProxiedPlayer extends Connection, CommandSender
* place to do so as this event occurs after a FML handshake has completed, * place to do so as this event occurs after a FML handshake has completed,
* if any has occurred. * if any has occurred.
* </p> * </p>
* *
* @return A {@link Map} of mods, where the key is the name of the mod, and * @return A {@link Map} of mods, where the key is the name of the mod, and
* the value is the version. Returns an empty list if the FML handshake has * the value is the version. Returns an empty list if the FML handshake has
* not occurred for this {@link ProxiedPlayer} yet. * not occurred for this {@link ProxiedPlayer} yet.

View File

@ -5,6 +5,7 @@ package net.md_5.bungee.api;
*/ */
public enum ChatMessageType public enum ChatMessageType
{ {
CHAT, CHAT,
SYSTEM, SYSTEM,
ACTION_BAR ACTION_BAR

View File

@ -18,11 +18,13 @@ public final class Configuration
final Map<String, Object> self; final Map<String, Object> self;
private final Configuration defaults; private final Configuration defaults;
public Configuration() { public Configuration()
{
this( null ); this( null );
} }
public Configuration(Configuration defaults) { public Configuration(Configuration defaults)
{
this( new LinkedHashMap<String, Object>(), defaults ); this( new LinkedHashMap<String, Object>(), defaults );
} }

View File

@ -29,14 +29,18 @@ public abstract class ConfigurationProvider
public abstract void save(Configuration config, Writer writer); public abstract void save(Configuration config, Writer writer);
public abstract Configuration load(File file) throws IOException; public abstract Configuration load(File file) throws IOException;
public abstract Configuration load(File file, Configuration defaults) throws IOException; public abstract Configuration load(File file, Configuration defaults) throws IOException;
public abstract Configuration load(Reader reader); public abstract Configuration load(Reader reader);
public abstract Configuration load(Reader reader, Configuration defaults); public abstract Configuration load(Reader reader, Configuration defaults);
public abstract Configuration load(InputStream is); public abstract Configuration load(InputStream is);
public abstract Configuration load(InputStream is, Configuration defaults); public abstract Configuration load(InputStream is, Configuration defaults);
public abstract Configuration load(String string); public abstract Configuration load(String string);
public abstract Configuration load(String string, Configuration defaults); public abstract Configuration load(String string, Configuration defaults);
} }

View File

@ -13,6 +13,7 @@ import net.md_5.bungee.protocol.DefinedPacket;
@EqualsAndHashCode(callSuper = false) @EqualsAndHashCode(callSuper = false)
public class LegacyPing extends DefinedPacket public class LegacyPing extends DefinedPacket
{ {
private final boolean v1_5; private final boolean v1_5;
@Override @Override

View File

@ -16,6 +16,7 @@ import net.md_5.bungee.protocol.ProtocolConstants;
@EqualsAndHashCode(callSuper = false) @EqualsAndHashCode(callSuper = false)
public class PlayerListHeaderFooter extends DefinedPacket public class PlayerListHeaderFooter extends DefinedPacket
{ {
private String header; private String header;
private String footer; private String footer;

View File

@ -14,6 +14,7 @@ import net.md_5.bungee.protocol.ProtocolConstants;
@EqualsAndHashCode(callSuper = false) @EqualsAndHashCode(callSuper = false)
public class Title extends DefinedPacket public class Title extends DefinedPacket
{ {
private Action action; private Action action;
// TITLE & SUBTITLE // TITLE & SUBTITLE
@ -68,6 +69,7 @@ public class Title extends DefinedPacket
public static enum Action public static enum Action
{ {
TITLE, TITLE,
SUBTITLE, SUBTITLE,
TIMES, TIMES,

View File

@ -10,6 +10,7 @@ import net.md_5.bungee.protocol.packet.Title.Action;
public class BungeeTitle implements Title public class BungeeTitle implements Title
{ {
private net.md_5.bungee.protocol.packet.Title title, subtitle, times, clear, reset; private net.md_5.bungee.protocol.packet.Title title, subtitle, times, clear, reset;
private static net.md_5.bungee.protocol.packet.Title createPacket(Action action) private static net.md_5.bungee.protocol.packet.Title createPacket(Action action)

View File

@ -92,7 +92,7 @@ public class ServerConnector extends PacketHandler
} }
copiedHandshake.setHost( newHost ); copiedHandshake.setHost( newHost );
} }
else if ( !user.getExtraDataInHandshake().isEmpty() ) else if ( !user.getExtraDataInHandshake().isEmpty() )
{ {
// Only restore the extra data if IP forwarding is off. // Only restore the extra data if IP forwarding is off.
// TODO: Add support for this data with IP forwarding. // TODO: Add support for this data with IP forwarding.

View File

@ -520,7 +520,7 @@ public final class UserConnection implements ProxiedPlayer
} }
@Override @Override
public boolean isForgeUser() public boolean isForgeUser()
{ {
return forgeClientHandler.isForgeUser(); return forgeClientHandler.isForgeUser();
} }

View File

@ -42,8 +42,8 @@ public class ForgeClientHandler
private PluginMessage serverIdList = null; private PluginMessage serverIdList = null;
/** /**
* Gets or sets a value indicating whether the '\00FML\00' token was found in * Gets or sets a value indicating whether the '\00FML\00' token was found
* the handshake. * in the handshake.
*/ */
@Getter @Getter
@Setter @Setter
@ -150,9 +150,9 @@ public class ForgeClientHandler
} }
/** /**
* Returns whether we know if the user is a forge user. * Returns whether we know if the user is a forge user. In FML 1.8, a "FML"
* In FML 1.8, a "FML" token is included in the initial handshake. * token is included in the initial handshake. We can use that to determine
* We can use that to determine if the user is a Forge 1.8 user. * if the user is a Forge 1.8 user.
* *
* @return <code>true</code> if the user is a forge user. * @return <code>true</code> if the user is a forge user.
*/ */

View File

@ -77,15 +77,15 @@ public class Global extends TabList
{ {
props[ j ] = new String[] props[ j ] = new String[]
{ {
loginResult.getProperties()[ j ].getName(), loginResult.getProperties()[ j ].getName(),
loginResult.getProperties()[ j ].getValue(), loginResult.getProperties()[ j ].getValue(),
loginResult.getProperties()[ j ].getSignature() loginResult.getProperties()[ j ].getSignature()
}; };
} }
item.setProperties( props ); item.setProperties( props );
} else } else
{ {
item.setProperties( new String[0][0] ); item.setProperties( new String[ 0 ][ 0 ] );
} }
item.setGamemode( ( (UserConnection) p ).getGamemode() ); item.setGamemode( ( (UserConnection) p ).getGamemode() );
item.setPing( p.getPing() ); item.setPing( p.getPing() );
@ -115,15 +115,16 @@ public class Global extends TabList
item.setUsername( player.getName() ); item.setUsername( player.getName() );
item.setDisplayName( ComponentSerializer.toString( TextComponent.fromLegacyText( player.getDisplayName() ) ) ); item.setDisplayName( ComponentSerializer.toString( TextComponent.fromLegacyText( player.getDisplayName() ) ) );
LoginResult loginResult = ( (UserConnection) player ).getPendingConnection().getLoginProfile(); LoginResult loginResult = ( (UserConnection) player ).getPendingConnection().getLoginProfile();
if ( loginResult != null ) { if ( loginResult != null )
{
String[][] props = new String[ loginResult.getProperties().length ][]; String[][] props = new String[ loginResult.getProperties().length ][];
for ( int j = 0; j < props.length; j++ ) for ( int j = 0; j < props.length; j++ )
{ {
props[ j ] = new String[] props[ j ] = new String[]
{ {
loginResult.getProperties()[ j ].getName(), loginResult.getProperties()[ j ].getName(),
loginResult.getProperties()[ j ].getValue(), loginResult.getProperties()[ j ].getValue(),
loginResult.getProperties()[ j ].getSignature() loginResult.getProperties()[ j ].getSignature()
}; };
} }
item.setProperties( props ); item.setProperties( props );

View File

@ -43,9 +43,9 @@ public abstract class TabList
{ {
props[ i ] = new String[] props[ i ] = new String[]
{ {
loginResult.getProperties()[ i ].getName(), loginResult.getProperties()[ i ].getName(),
loginResult.getProperties()[ i ].getValue(), loginResult.getProperties()[ i ].getValue(),
loginResult.getProperties()[ i ].getSignature() loginResult.getProperties()[ i ].getSignature()
}; };
} }
item.setProperties( props ); item.setProperties( props );