Line endings. Don't make me yell at you.

This commit is contained in:
Dinnerbone 2011-05-12 22:28:09 +01:00
parent 79f2d05482
commit ed7a7ab265
5 changed files with 535 additions and 535 deletions

View File

@ -1,77 +1,77 @@
package org.bukkit.event.block; package org.bukkit.event.block;
import org.bukkit.block.Block; import org.bukkit.block.Block;
import org.bukkit.event.Cancellable; import org.bukkit.event.Cancellable;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
import org.bukkit.util.Vector; import org.bukkit.util.Vector;
/** /**
* Event called on dispense of an item from a block. * Event called on dispense of an item from a block.
* *
* @author sk89q * @author sk89q
*/ */
public class BlockDispenseEvent extends BlockEvent implements Cancellable { public class BlockDispenseEvent extends BlockEvent implements Cancellable {
private boolean cancelled = false; private boolean cancelled = false;
private ItemStack item; private ItemStack item;
private Vector velocity; private Vector velocity;
public BlockDispenseEvent(Block block, ItemStack dispensed, Vector velocity) { public BlockDispenseEvent(Block block, ItemStack dispensed, Vector velocity) {
super(Type.BLOCK_DISPENSE, block); super(Type.BLOCK_DISPENSE, block);
this.item = dispensed; this.item = dispensed;
this.velocity = velocity; this.velocity = velocity;
} }
/** /**
* Get the item that is being dispensed. Modifying the returned item * Get the item that is being dispensed. Modifying the returned item
* will have no effect. * will have no effect.
* *
* @return * @return
*/ */
public ItemStack getItem() { public ItemStack getItem() {
return item.clone(); return item.clone();
} }
/** /**
* Set the item being dispensed. * Set the item being dispensed.
* *
* @param item * @param item
*/ */
public void setItem(ItemStack item) { public void setItem(ItemStack item) {
this.item = item; this.item = item;
} }
/** /**
* Gets the velocity. Modifying the returned Vector will not * Gets the velocity. Modifying the returned Vector will not
* change the velocity. * change the velocity.
* *
* @return * @return
*/ */
public Vector getVelocity() { public Vector getVelocity() {
return velocity.clone(); return velocity.clone();
} }
/** /**
* Set the velocity. * Set the velocity.
* *
* @param vel * @param vel
*/ */
public void setVelocity(Vector vel) { public void setVelocity(Vector vel) {
velocity = vel; velocity = vel;
} }
/** /**
* Check to see if the event was cancelled. * Check to see if the event was cancelled.
*/ */
public boolean isCancelled() { public boolean isCancelled() {
return cancelled; return cancelled;
} }
/** /**
* Prevent dispensing. * Prevent dispensing.
*/ */
public void setCancelled(boolean cancel) { public void setCancelled(boolean cancel) {
cancelled = cancel; cancelled = cancel;
} }
} }

View File

@ -1,50 +1,50 @@
package org.bukkit.plugin; package org.bukkit.plugin;
/** /**
* A registered service provider. * A registered service provider.
* *
* @author sk89q * @author sk89q
* @param <T> Service * @param <T> Service
*/ */
public class RegisteredServiceProvider<T> public class RegisteredServiceProvider<T>
implements Comparable<RegisteredServiceProvider<?>> { implements Comparable<RegisteredServiceProvider<?>> {
private Class<T> service; private Class<T> service;
private Plugin plugin; private Plugin plugin;
private T provider; private T provider;
private ServicePriority priority; private ServicePriority priority;
public RegisteredServiceProvider(Class<T> service, T provider, public RegisteredServiceProvider(Class<T> service, T provider,
ServicePriority priority, Plugin plugin) { ServicePriority priority, Plugin plugin) {
this.service = service; this.service = service;
this.plugin = plugin; this.plugin = plugin;
this.provider = provider; this.provider = provider;
this.priority = priority; this.priority = priority;
} }
public Class<T> getService() { public Class<T> getService() {
return service; return service;
} }
public Plugin getPlugin() { public Plugin getPlugin() {
return plugin; return plugin;
} }
public T getProvider() { public T getProvider() {
return provider; return provider;
} }
public ServicePriority getPriority() { public ServicePriority getPriority() {
return priority; return priority;
} }
public int compareTo(RegisteredServiceProvider<?> other) { public int compareTo(RegisteredServiceProvider<?> other) {
if (priority.ordinal() == other.getPriority().ordinal()) { if (priority.ordinal() == other.getPriority().ordinal()) {
return 0; return 0;
} else { } else {
return priority.ordinal() < other.getPriority().ordinal() ? 1 : -1; return priority.ordinal() < other.getPriority().ordinal() ? 1 : -1;
} }
} }
} }

View File

@ -1,12 +1,12 @@
package org.bukkit.plugin; package org.bukkit.plugin;
/** /**
* Represents various priorities of a provider. * Represents various priorities of a provider.
*/ */
public enum ServicePriority { public enum ServicePriority {
Lowest, Lowest,
Low, Low,
Normal, Normal,
High, High,
Highest Highest
} }

View File

@ -1,110 +1,110 @@
package org.bukkit.plugin; package org.bukkit.plugin;
import java.util.Collection; import java.util.Collection;
import java.util.List; import java.util.List;
/** /**
* Manages services and service providers. Services are an interface specifying * Manages services and service providers. Services are an interface specifying
* a list of methods that a provider must implement. Providers are * a list of methods that a provider must implement. Providers are
* implementations of these services. A provider can be queried from the * implementations of these services. A provider can be queried from the
* services manager in order to use a service (if one is available). If * services manager in order to use a service (if one is available). If
* multiple plugins register a service, then the service with the highest * multiple plugins register a service, then the service with the highest
* priority takes precedence. * priority takes precedence.
* *
* @author sk89q * @author sk89q
*/ */
public interface ServicesManager { public interface ServicesManager {
/** /**
* Register a provider of a service. * Register a provider of a service.
* *
* @param <T> Provider * @param <T> Provider
* @param service service class * @param service service class
* @param provider provider to register * @param provider provider to register
* @param plugin plugin with the provider * @param plugin plugin with the provider
* @param priority priority of the provider * @param priority priority of the provider
*/ */
public <T> void register(Class<T> service, T provider, Plugin plugin, public <T> void register(Class<T> service, T provider, Plugin plugin,
ServicePriority priority); ServicePriority priority);
/** /**
* Unregister all the providers registered by a particular plugin. * Unregister all the providers registered by a particular plugin.
* *
* @param plugin * @param plugin
*/ */
public void unregisterAll(Plugin plugin); public void unregisterAll(Plugin plugin);
/** /**
* Unregister a particular provider for a particular service. * Unregister a particular provider for a particular service.
* *
* @param service * @param service
* @param provider * @param provider
*/ */
public void unregister(Class<?> service, Object provider); public void unregister(Class<?> service, Object provider);
/** /**
* Unregister a particular provider. * Unregister a particular provider.
* *
* @param provider * @param provider
*/ */
public void unregister(Object provider); public void unregister(Object provider);
/** /**
* Queries for a provider. This may return if no provider has been * Queries for a provider. This may return if no provider has been
* registered for a service. The highest priority provider is returned. * registered for a service. The highest priority provider is returned.
* *
* @param <T> * @param <T>
* @param service * @param service
* @return provider or null * @return provider or null
*/ */
public <T> T load(Class<T> service); public <T> T load(Class<T> service);
/** /**
* Queries for a provider registration. This may return if no provider * Queries for a provider registration. This may return if no provider
* has been registered for a service. * has been registered for a service.
* *
* @param <T> * @param <T>
* @param service * @param service
* @return provider registration or null * @return provider registration or null
*/ */
public <T> RegisteredServiceProvider<T> getRegistration(Class<T> service); public <T> RegisteredServiceProvider<T> getRegistration(Class<T> service);
/** /**
* Get registrations of providers for a plugin. * Get registrations of providers for a plugin.
* *
* @param plugin * @param plugin
* @return provider registration or null * @return provider registration or null
*/ */
public List<RegisteredServiceProvider<?>> getRegistrations(Plugin plugin); public List<RegisteredServiceProvider<?>> getRegistrations(Plugin plugin);
/** /**
* Get registrations of providers for a service. The returned list is * Get registrations of providers for a service. The returned list is
* unmodifiable. * unmodifiable.
* *
* @param <T> * @param <T>
* @param service * @param service
* @return list of registrations * @return list of registrations
*/ */
public <T> Collection<RegisteredServiceProvider<T>> getRegistrations( public <T> Collection<RegisteredServiceProvider<T>> getRegistrations(
Class<T> service); Class<T> service);
/** /**
* Get a list of known services. A service is known if it has registered * Get a list of known services. A service is known if it has registered
* providers for it. * providers for it.
* *
* @return list of known services * @return list of known services
*/ */
public Collection<Class<?>> getKnownServices(); public Collection<Class<?>> getKnownServices();
/** /**
* Returns whether a provider has been registered for a service. Do not * Returns whether a provider has been registered for a service. Do not
* check this first only to call <code>load(service)</code> later, as that * check this first only to call <code>load(service)</code> later, as that
* would be a non-thread safe situation. * would be a non-thread safe situation.
* *
* @param <T> service * @param <T> service
* @param service service to check * @param service service to check
* @return whether there has been a registered provider * @return whether there has been a registered provider
*/ */
public <T> boolean isProvidedFor(Class<T> service); public <T> boolean isProvidedFor(Class<T> service);
} }

View File

@ -1,288 +1,288 @@
package org.bukkit.plugin; package org.bukkit.plugin;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
import java.util.Iterator; import java.util.Iterator;
import java.util.Map; import java.util.Map;
import java.util.List; import java.util.List;
import java.util.NoSuchElementException; import java.util.NoSuchElementException;
/** /**
* A simple services manager. * A simple services manager.
* *
* @author sk89q * @author sk89q
*/ */
public class SimpleServicesManager implements ServicesManager { public class SimpleServicesManager implements ServicesManager {
/** /**
* Map of providers. * Map of providers.
*/ */
private final Map<Class<?>, List<RegisteredServiceProvider<?>>> providers = private final Map<Class<?>, List<RegisteredServiceProvider<?>>> providers =
new HashMap<Class<?>, List<RegisteredServiceProvider<?>>>(); new HashMap<Class<?>, List<RegisteredServiceProvider<?>>>();
/** /**
* Register a provider of a service. * Register a provider of a service.
* *
* @param <T> Provider * @param <T> Provider
* @param service service class * @param service service class
* @param provider provider to register * @param provider provider to register
* @param plugin plugin with the provider * @param plugin plugin with the provider
* @param priority priority of the provider * @param priority priority of the provider
*/ */
public <T> void register(Class<T> service, T provider, public <T> void register(Class<T> service, T provider,
Plugin plugin, ServicePriority priority) { Plugin plugin, ServicePriority priority) {
synchronized (providers) { synchronized (providers) {
List<RegisteredServiceProvider<?>> registered = List<RegisteredServiceProvider<?>> registered =
providers.get(service); providers.get(service);
if (registered == null) { if (registered == null) {
registered = new ArrayList<RegisteredServiceProvider<?>>(); registered = new ArrayList<RegisteredServiceProvider<?>>();
providers.put(service, registered); providers.put(service, registered);
} }
registered.add(new RegisteredServiceProvider<T>( registered.add(new RegisteredServiceProvider<T>(
service, provider, priority, plugin)); service, provider, priority, plugin));
// Make sure that providers are in the right order in order // Make sure that providers are in the right order in order
// for priorities to work correctly // for priorities to work correctly
Collections.sort(registered); Collections.sort(registered);
} }
} }
/** /**
* Unregister all the providers registered by a particular plugin. * Unregister all the providers registered by a particular plugin.
* *
* @param plugin * @param plugin
*/ */
public void unregisterAll(Plugin plugin) { public void unregisterAll(Plugin plugin) {
synchronized (providers) { synchronized (providers) {
Iterator<Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>>> it = Iterator<Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>>> it =
providers.entrySet().iterator(); providers.entrySet().iterator();
try { try {
while (it.hasNext()) { while (it.hasNext()) {
Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>> entry = it.next(); Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>> entry = it.next();
Iterator<RegisteredServiceProvider<?>> it2 = entry.getValue().iterator(); Iterator<RegisteredServiceProvider<?>> it2 = entry.getValue().iterator();
try { try {
// Removed entries that are from this plugin // Removed entries that are from this plugin
while (it2.hasNext()) { while (it2.hasNext()) {
if (it2.next().getPlugin() == plugin) { if (it2.next().getPlugin() == plugin) {
it2.remove(); it2.remove();
} }
} }
} catch (NoSuchElementException e) { } catch (NoSuchElementException e) {
// Why does Java suck // Why does Java suck
} }
// Get rid of the empty list // Get rid of the empty list
if (entry.getValue().size() == 0) { if (entry.getValue().size() == 0) {
it.remove(); it.remove();
} }
} }
} catch (NoSuchElementException e) { } catch (NoSuchElementException e) {
} }
} }
} }
/** /**
* Unregister a particular provider for a particular service. * Unregister a particular provider for a particular service.
* *
* @param service * @param service
* @param provider * @param provider
*/ */
public void unregister(Class<?> service, Object provider) { public void unregister(Class<?> service, Object provider) {
synchronized (providers) { synchronized (providers) {
Iterator<Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>>> it = Iterator<Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>>> it =
providers.entrySet().iterator(); providers.entrySet().iterator();
try { try {
while (it.hasNext()) { while (it.hasNext()) {
Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>> entry = it.next(); Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>> entry = it.next();
// We want a particular service // We want a particular service
if (entry.getKey() != service) { if (entry.getKey() != service) {
continue; continue;
} }
Iterator<RegisteredServiceProvider<?>> it2 = entry.getValue().iterator(); Iterator<RegisteredServiceProvider<?>> it2 = entry.getValue().iterator();
try { try {
// Removed entries that are from this plugin // Removed entries that are from this plugin
while (it2.hasNext()) { while (it2.hasNext()) {
if (it2.next().getProvider() == provider) { if (it2.next().getProvider() == provider) {
it2.remove(); it2.remove();
} }
} }
} catch (NoSuchElementException e) { } catch (NoSuchElementException e) {
// Why does Java suck // Why does Java suck
} }
// Get rid of the empty list // Get rid of the empty list
if (entry.getValue().size() == 0) { if (entry.getValue().size() == 0) {
it.remove(); it.remove();
} }
} }
} catch (NoSuchElementException e) { } catch (NoSuchElementException e) {
} }
} }
} }
/** /**
* Unregister a particular provider. * Unregister a particular provider.
* *
* @param provider * @param provider
*/ */
public void unregister(Object provider) { public void unregister(Object provider) {
synchronized (providers) { synchronized (providers) {
Iterator<Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>>> it = Iterator<Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>>> it =
providers.entrySet().iterator(); providers.entrySet().iterator();
try { try {
while (it.hasNext()) { while (it.hasNext()) {
Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>> entry = it.next(); Map.Entry<Class<?>, List<RegisteredServiceProvider<?>>> entry = it.next();
Iterator<RegisteredServiceProvider<?>> it2 = entry.getValue().iterator(); Iterator<RegisteredServiceProvider<?>> it2 = entry.getValue().iterator();
try { try {
// Removed entries that are from this plugin // Removed entries that are from this plugin
while (it2.hasNext()) { while (it2.hasNext()) {
if (it2.next().getProvider() == provider) { if (it2.next().getProvider() == provider) {
it2.remove(); it2.remove();
} }
} }
} catch (NoSuchElementException e) { } catch (NoSuchElementException e) {
// Why does Java suck // Why does Java suck
} }
// Get rid of the empty list // Get rid of the empty list
if (entry.getValue().size() == 0) { if (entry.getValue().size() == 0) {
it.remove(); it.remove();
} }
} }
} catch (NoSuchElementException e) { } catch (NoSuchElementException e) {
} }
} }
} }
/** /**
* Queries for a provider. This may return if no provider has been * Queries for a provider. This may return if no provider has been
* registered for a service. The highest priority provider is returned. * registered for a service. The highest priority provider is returned.
* *
* @param <T> * @param <T>
* @param service * @param service
* @return provider or null * @return provider or null
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public <T> T load(Class<T> service) { public <T> T load(Class<T> service) {
synchronized (providers) { synchronized (providers) {
List<RegisteredServiceProvider<?>> registered = providers.get(service); List<RegisteredServiceProvider<?>> registered = providers.get(service);
if (registered == null) { if (registered == null) {
return null; return null;
} }
// This should not be null! // This should not be null!
return (T) registered.get(0).getProvider(); return (T) registered.get(0).getProvider();
} }
} }
/** /**
* Queries for a provider registration. This may return if no provider * Queries for a provider registration. This may return if no provider
* has been registered for a service. * has been registered for a service.
* *
* @param <T> * @param <T>
* @param service * @param service
* @return provider registration or null * @return provider registration or null
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public <T> RegisteredServiceProvider<T> getRegistration(Class<T> service) { public <T> RegisteredServiceProvider<T> getRegistration(Class<T> service) {
synchronized (providers) { synchronized (providers) {
List<RegisteredServiceProvider<?>> registered = providers.get(service); List<RegisteredServiceProvider<?>> registered = providers.get(service);
if (registered == null) { if (registered == null) {
return null; return null;
} }
// This should not be null! // This should not be null!
return (RegisteredServiceProvider<T>) registered.get(0); return (RegisteredServiceProvider<T>) registered.get(0);
} }
} }
/** /**
* Get registrations of providers for a plugin. * Get registrations of providers for a plugin.
* *
* @param plugin * @param plugin
* @return provider registration or null * @return provider registration or null
*/ */
public List<RegisteredServiceProvider<?>> getRegistrations(Plugin plugin) { public List<RegisteredServiceProvider<?>> getRegistrations(Plugin plugin) {
synchronized (providers) { synchronized (providers) {
List<RegisteredServiceProvider<?>> ret = List<RegisteredServiceProvider<?>> ret =
new ArrayList<RegisteredServiceProvider<?>>(); new ArrayList<RegisteredServiceProvider<?>>();
for (List<RegisteredServiceProvider<?>> registered : providers.values()) { for (List<RegisteredServiceProvider<?>> registered : providers.values()) {
for (RegisteredServiceProvider<?> provider : registered) { for (RegisteredServiceProvider<?> provider : registered) {
if (provider.getPlugin() == plugin) { if (provider.getPlugin() == plugin) {
ret.add(provider); ret.add(provider);
} }
} }
} }
return ret; return ret;
} }
} }
/** /**
* Get registrations of providers for a service. The returned list is * Get registrations of providers for a service. The returned list is
* unmodifiable. * unmodifiable.
* *
* @param <T> * @param <T>
* @param service * @param service
* @return list of registrations * @return list of registrations
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
public <T> Collection<RegisteredServiceProvider<T>> getRegistrations(Class<T> service) { public <T> Collection<RegisteredServiceProvider<T>> getRegistrations(Class<T> service) {
synchronized (providers) { synchronized (providers) {
List<RegisteredServiceProvider<?>> registered = providers.get(service); List<RegisteredServiceProvider<?>> registered = providers.get(service);
if (registered == null) { if (registered == null) {
return Collections.unmodifiableList( return Collections.unmodifiableList(
new ArrayList<RegisteredServiceProvider<T>>()); new ArrayList<RegisteredServiceProvider<T>>());
} }
List<RegisteredServiceProvider<T>> ret = List<RegisteredServiceProvider<T>> ret =
new ArrayList<RegisteredServiceProvider<T>>(); new ArrayList<RegisteredServiceProvider<T>>();
for (RegisteredServiceProvider<?> provider : registered) { for (RegisteredServiceProvider<?> provider : registered) {
ret.add((RegisteredServiceProvider<T>) provider); ret.add((RegisteredServiceProvider<T>) provider);
} }
return Collections.unmodifiableList(ret); return Collections.unmodifiableList(ret);
} }
} }
/** /**
* Get a list of known services. A service is known if it has registered * Get a list of known services. A service is known if it has registered
* providers for it. * providers for it.
* *
* @return list of known services * @return list of known services
*/ */
public Collection<Class<?>> getKnownServices() { public Collection<Class<?>> getKnownServices() {
return Collections.unmodifiableSet(providers.keySet()); return Collections.unmodifiableSet(providers.keySet());
} }
/** /**
* Returns whether a provider has been registered for a service. Do not * Returns whether a provider has been registered for a service. Do not
* check this first only to call <code>load(service)</code> later, as that * check this first only to call <code>load(service)</code> later, as that
* would be a non-thread safe situation. * would be a non-thread safe situation.
* *
* @param <T> service * @param <T> service
* @param service service to check * @param service service to check
* @return whether there has been a registered provider * @return whether there has been a registered provider
*/ */
public <T> boolean isProvidedFor(Class<T> service) { public <T> boolean isProvidedFor(Class<T> service) {
return getRegistration(service) != null; return getRegistration(service) != null;
} }
} }