Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/deprecated-list.html b/docs/javadoc/helper-mongo/deprecated-list.html new file mode 100644 index 00000000..01bf0456 --- /dev/null +++ b/docs/javadoc/helper-mongo/deprecated-list.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/help-doc.html b/docs/javadoc/helper-mongo/help-doc.html new file mode 100644 index 00000000..b8d1861b --- /dev/null +++ b/docs/javadoc/helper-mongo/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/index-all.html b/docs/javadoc/helper-mongo/index-all.html new file mode 100644 index 00000000..44309119 --- /dev/null +++ b/docs/javadoc/helper-mongo/index-all.html @@ -0,0 +1,275 @@ + + + + + + +HelperMongo instances.Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/index.html b/docs/javadoc/helper-mongo/index.html new file mode 100644 index 00000000..8da5b6ce --- /dev/null +++ b/docs/javadoc/helper-mongo/index.html @@ -0,0 +1,76 @@ + + + + + + +public interface HelperMongo
+extends me.lucko.helper.terminable.Terminable
+EMPTY| Modifier and Type | +Method and Description | +
|---|---|
com.mongodb.MongoClient |
+getClient()
+Gets the client instance backing the datasource
+ |
+
com.mongodb.client.MongoDatabase |
+getDatabase()
+Gets the main database in use by the instance.
+ |
+
com.mongodb.client.MongoDatabase |
+getDatabase(String name)
+Gets a specific database instance
+ |
+
org.mongodb.morphia.Morphia |
+getMorphia()
+Gets the Morphia instance for this datasource
+ |
+
org.mongodb.morphia.Datastore |
+getMorphiaDatastore()
+Gets the main Morphia datastore in use by the instance
+ |
+
org.mongodb.morphia.Datastore |
+getMorphiaDatastore(String name)
+Gets a specific Morphia datastore instance
+ |
+
static HelperMongo |
+usingMongoDb(MongoDatabaseCredentials credentials) |
+
bindWith, hasTerminated, of, terminate@Nonnull +static HelperMongo usingMongoDb(@Nonnull + MongoDatabaseCredentials credentials)+
@Nonnull +com.mongodb.MongoClient getClient()+
@Nonnull +com.mongodb.client.MongoDatabase getDatabase()+
com.mongodb.client.MongoDatabase getDatabase(String name)+
name - the name of the databaseorg.mongodb.morphia.Morphia getMorphia()+
org.mongodb.morphia.Datastore getMorphiaDatastore()+
org.mongodb.morphia.Datastore getMorphiaDatastore(String name)+
name - the name of the databaseCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/MongoDatabaseCredentials.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/MongoDatabaseCredentials.html new file mode 100644 index 00000000..1d6a16d7 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/MongoDatabaseCredentials.html @@ -0,0 +1,388 @@ + + + + + + +public final class MongoDatabaseCredentials +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
static MongoDatabaseCredentials |
+fromConfig(org.bukkit.configuration.ConfigurationSection config) |
+
String |
+getAddress() |
+
String |
+getDatabase() |
+
String |
+getPassword() |
+
int |
+getPort() |
+
String |
+getUsername() |
+
int |
+hashCode() |
+
static MongoDatabaseCredentials |
+of(String address,
+ int port,
+ String database,
+ String username,
+ String password) |
+
String |
+toString() |
+
@Nonnull +public static MongoDatabaseCredentials of(@Nonnull + String address, + int port, + @Nonnull + String database, + @Nonnull + String username, + @Nonnull + String password)+
@Nonnull +public static MongoDatabaseCredentials fromConfig(@Nonnull + org.bukkit.configuration.ConfigurationSection config)+
public int getPort()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/MongoProvider.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/MongoProvider.html new file mode 100644 index 00000000..263eab18 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/MongoProvider.html @@ -0,0 +1,284 @@ + + + + + + +public interface MongoProvider
+HelperMongo instances.| Modifier and Type | +Method and Description | +
|---|---|
HelperMongo |
+getDataSource()
+Gets the global datasource.
+ |
+
HelperMongo |
+getDataSource(MongoDatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
MongoDatabaseCredentials |
+getGlobalCredentials()
+Gets the global database credentials being used for the global datasource.
+ |
+
@Nonnull +HelperMongo getDataSource()+
@Nonnull +HelperMongo getDataSource(@Nonnull + MongoDatabaseCredentials credentials)+
These instances are not cached, and a new datasource is created each + time this method is called.
credentials - the credentials for the database@Nonnull +MongoDatabaseCredentials getGlobalCredentials()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/HelperMongo.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/HelperMongo.html new file mode 100644 index 00000000..3ed139e1 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/HelperMongo.html @@ -0,0 +1,217 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.mongo | ++ |
| me.lucko.helper.mongo.plugin | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
HelperMongo |
+MongoProvider.getDataSource()
+Gets the global datasource.
+ |
+
HelperMongo |
+MongoProvider.getDataSource(MongoDatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
static HelperMongo |
+HelperMongo.usingMongoDb(MongoDatabaseCredentials credentials) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+MongoWrapper |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperMongo |
+MongoPlugin.getDataSource() |
+
HelperMongo |
+MongoPlugin.getDataSource(MongoDatabaseCredentials credentials) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/MongoDatabaseCredentials.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/MongoDatabaseCredentials.html new file mode 100644 index 00000000..a7efc6dc --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/MongoDatabaseCredentials.html @@ -0,0 +1,245 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.mongo | ++ |
| me.lucko.helper.mongo.plugin | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static MongoDatabaseCredentials |
+MongoDatabaseCredentials.fromConfig(org.bukkit.configuration.ConfigurationSection config) |
+
MongoDatabaseCredentials |
+MongoProvider.getGlobalCredentials()
+Gets the global database credentials being used for the global datasource.
+ |
+
static MongoDatabaseCredentials |
+MongoDatabaseCredentials.of(String address,
+ int port,
+ String database,
+ String username,
+ String password) |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperMongo |
+MongoProvider.getDataSource(MongoDatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
static HelperMongo |
+HelperMongo.usingMongoDb(MongoDatabaseCredentials credentials) |
+
| Modifier and Type | +Method and Description | +
|---|---|
MongoDatabaseCredentials |
+MongoPlugin.getGlobalCredentials() |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperMongo |
+MongoPlugin.getDataSource(MongoDatabaseCredentials credentials) |
+
| Constructor and Description | +
|---|
MongoWrapper(MongoDatabaseCredentials credentials) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/MongoProvider.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/MongoProvider.html new file mode 100644 index 00000000..462f832f --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/class-use/MongoProvider.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.mongo.plugin | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+MongoPlugin |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-frame.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-frame.html new file mode 100644 index 00000000..789847ce --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Interface | +Description | +
|---|---|
| HelperMongo | +
+ Represents an individual Mongo datasource, created by the library.
+ |
+
| MongoProvider | +
+ Provides
+HelperMongo instances. |
+
| Class | +Description | +
|---|---|
| MongoDatabaseCredentials | +
+ Represents the credentials for a remote database.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-tree.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-tree.html new file mode 100644 index 00000000..da20d79d --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-use.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-use.html new file mode 100644 index 00000000..32c1b3b3 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/package-use.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.mongo | ++ |
| me.lucko.helper.mongo.plugin | ++ |
| Class and Description | +
|---|
| HelperMongo
+ Represents an individual Mongo datasource, created by the library.
+ |
+
| MongoDatabaseCredentials
+ Represents the credentials for a remote database.
+ |
+
| Class and Description | +
|---|
| HelperMongo
+ Represents an individual Mongo datasource, created by the library.
+ |
+
| MongoDatabaseCredentials
+ Represents the credentials for a remote database.
+ |
+
| MongoProvider
+ Provides
+HelperMongo instances. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/MongoPlugin.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/MongoPlugin.html new file mode 100644 index 00000000..ab137252 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/MongoPlugin.html @@ -0,0 +1,396 @@ + + + + + + +public class MongoPlugin +extends me.lucko.helper.plugin.ExtendedJavaPlugin +implements MongoProvider+
| Constructor and Description | +
|---|
MongoPlugin() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+enable() |
+
HelperMongo |
+getDataSource()
+Gets the global datasource.
+ |
+
HelperMongo |
+getDataSource(MongoDatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
MongoDatabaseCredentials |
+getGlobalCredentials()
+Gets the global database credentials being used for the global datasource.
+ |
+
bind, bindComposite, bindRunnable, disable, getBundledFile, getPlugin, getService, load, loadConfig, onDisable, onEnable, onLoad, provideService, provideService, registerCommand, registerListenergetClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toStringequals, getName, hashCodeprotected void enable()+
enable in class me.lucko.helper.plugin.ExtendedJavaPlugin@Nonnull +public HelperMongo getDataSource()+
MongoProvidergetDataSource in interface MongoProvider@Nonnull +public HelperMongo getDataSource(@Nonnull + MongoDatabaseCredentials credentials)+
MongoProviderThese instances are not cached, and a new datasource is created each + time this method is called.
getDataSource in interface MongoProvidercredentials - the credentials for the database@Nonnull +public MongoDatabaseCredentials getGlobalCredentials()+
MongoProvidergetGlobalCredentials in interface MongoProviderCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/MongoWrapper.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/MongoWrapper.html new file mode 100644 index 00000000..396918ef --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/MongoWrapper.html @@ -0,0 +1,456 @@ + + + + + + +public class MongoWrapper +extends Object +implements HelperMongo+
EMPTY| Constructor and Description | +
|---|
MongoWrapper(MongoDatabaseCredentials credentials) |
+
| Modifier and Type | +Method and Description | +
|---|---|
com.mongodb.MongoClient |
+getClient()
+Gets the client instance backing the datasource
+ |
+
com.mongodb.client.MongoDatabase |
+getDatabase()
+Gets the main database in use by the instance.
+ |
+
com.mongodb.client.MongoDatabase |
+getDatabase(String name)
+Gets a specific database instance
+ |
+
org.mongodb.morphia.Morphia |
+getMorphia()
+Gets the Morphia instance for this datasource
+ |
+
org.mongodb.morphia.Datastore |
+getMorphiaDatastore()
+Gets the main Morphia datastore in use by the instance
+ |
+
org.mongodb.morphia.Datastore |
+getMorphiaDatastore(String name)
+Gets a specific Morphia datastore instance
+ |
+
boolean |
+terminate() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitusingMongoDbbindWith, hasTerminated, ofpublic MongoWrapper(@Nonnull + MongoDatabaseCredentials credentials)+
@Nonnull +public com.mongodb.MongoClient getClient()+
HelperMongogetClient in interface HelperMongo@Nonnull +public com.mongodb.client.MongoDatabase getDatabase()+
HelperMongogetDatabase in interface HelperMongopublic com.mongodb.client.MongoDatabase getDatabase(String name)+
HelperMongogetDatabase in interface HelperMongoname - the name of the databasepublic boolean terminate()+
terminate in interface me.lucko.helper.terminable.Terminablepublic org.mongodb.morphia.Morphia getMorphia()+
HelperMongogetMorphia in interface HelperMongopublic org.mongodb.morphia.Datastore getMorphiaDatastore()+
HelperMongogetMorphiaDatastore in interface HelperMongopublic org.mongodb.morphia.Datastore getMorphiaDatastore(String name)+
HelperMongogetMorphiaDatastore in interface HelperMongoname - the name of the databaseCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/class-use/MongoPlugin.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/class-use/MongoPlugin.html new file mode 100644 index 00000000..01c3bd73 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/class-use/MongoPlugin.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/class-use/MongoWrapper.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/class-use/MongoWrapper.html new file mode 100644 index 00000000..4815f8ef --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/class-use/MongoWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-frame.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-frame.html new file mode 100644 index 00000000..c6a3ad72 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| MongoPlugin | ++ |
| MongoWrapper | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-tree.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-tree.html new file mode 100644 index 00000000..d8a38bc1 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-use.html b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-use.html new file mode 100644 index 00000000..2ccd2d67 --- /dev/null +++ b/docs/javadoc/helper-mongo/me/lucko/helper/mongo/plugin/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/overview-frame.html b/docs/javadoc/helper-mongo/overview-frame.html new file mode 100644 index 00000000..6e6f39b4 --- /dev/null +++ b/docs/javadoc/helper-mongo/overview-frame.html @@ -0,0 +1,23 @@ + + + + + + ++ + diff --git a/docs/javadoc/helper-mongo/overview-summary.html b/docs/javadoc/helper-mongo/overview-summary.html new file mode 100644 index 00000000..730ee57d --- /dev/null +++ b/docs/javadoc/helper-mongo/overview-summary.html @@ -0,0 +1,144 @@ + + + + + + +
| Package | +Description | +
|---|---|
| me.lucko.helper.mongo | ++ |
| me.lucko.helper.mongo.plugin | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/overview-tree.html b/docs/javadoc/helper-mongo/overview-tree.html new file mode 100644 index 00000000..b6e3e896 --- /dev/null +++ b/docs/javadoc/helper-mongo/overview-tree.html @@ -0,0 +1,163 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-mongo/package-list b/docs/javadoc/helper-mongo/package-list new file mode 100644 index 00000000..046ef036 --- /dev/null +++ b/docs/javadoc/helper-mongo/package-list @@ -0,0 +1,2 @@ +me.lucko.helper.mongo +me.lucko.helper.mongo.plugin diff --git a/docs/javadoc/helper-mongo/resources/fonts/dejavu.css b/docs/javadoc/helper-mongo/resources/fonts/dejavu.css new file mode 100644 index 00000000..82b867f5 --- /dev/null +++ b/docs/javadoc/helper-mongo/resources/fonts/dejavu.css @@ -0,0 +1 @@ +h1{font-family:"Dejavu Sans";font-size:24px;font-style:normal;font-variant:normal;font-weight:500;line-height:26.4px;}h3{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:500;line-height:15.4px;}p{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:400;line-height:20px;}blockquote{font-family:"Dejavu Sans";font-size:21px;font-style:normal;font-variant:normal;font-weight:400;line-height:30px;}pre{font-family:"Dejavu Sans";font-size:13px;font-style:normal;font-variant:normal;font-weight:400;line-height:18.5714px;} diff --git a/docs/javadoc/helper-mongo/script.js b/docs/javadoc/helper-mongo/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadoc/helper-mongo/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadoc/helper-mongo/stylesheet.css b/docs/javadoc/helper-mongo/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadoc/helper-mongo/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/docs/javadoc/helper-redis/allclasses-frame.html b/docs/javadoc/helper-redis/allclasses-frame.html new file mode 100644 index 00000000..e0c28849 --- /dev/null +++ b/docs/javadoc/helper-redis/allclasses-frame.html @@ -0,0 +1,24 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/deprecated-list.html b/docs/javadoc/helper-redis/deprecated-list.html new file mode 100644 index 00000000..37f31d3e --- /dev/null +++ b/docs/javadoc/helper-redis/deprecated-list.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/help-doc.html b/docs/javadoc/helper-redis/help-doc.html new file mode 100644 index 00000000..2e1bcd92 --- /dev/null +++ b/docs/javadoc/helper-redis/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/index-all.html b/docs/javadoc/helper-redis/index-all.html new file mode 100644 index 00000000..d143cf94 --- /dev/null +++ b/docs/javadoc/helper-redis/index-all.html @@ -0,0 +1,263 @@ + + + + + + +HelperRedis instances.Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/index.html b/docs/javadoc/helper-redis/index.html new file mode 100644 index 00000000..017fe56b --- /dev/null +++ b/docs/javadoc/helper-redis/index.html @@ -0,0 +1,76 @@ + + + + + + +public interface HelperRedis
+extends me.lucko.helper.terminable.Terminable, me.lucko.helper.messaging.Messenger
+EMPTY| Modifier and Type | +Method and Description | +
|---|---|
redis.clients.jedis.Jedis |
+getJedis()
+Gets a Jedis instance from the JedisPool.
+ |
+
redis.clients.jedis.JedisPool |
+getJedisPool()
+Gets the JedisPool instance backing the redis instance
+ |
+
static HelperRedis |
+usingJedis(RedisCredentials credentials) |
+
bindWith, hasTerminated, of, terminategetChannel, getChannel, getChannel@Nonnull +static HelperRedis usingJedis(@Nonnull + RedisCredentials credentials)+
@Nonnull +redis.clients.jedis.JedisPool getJedisPool()+
@Nonnull +redis.clients.jedis.Jedis getJedis()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/RedisCredentials.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/RedisCredentials.html new file mode 100644 index 00000000..5bd1deaf --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/RedisCredentials.html @@ -0,0 +1,368 @@ + + + + + + +public final class RedisCredentials +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
static RedisCredentials |
+fromConfig(org.bukkit.configuration.ConfigurationSection config) |
+
String |
+getAddress() |
+
String |
+getPassword() |
+
int |
+getPort() |
+
int |
+hashCode() |
+
static RedisCredentials |
+of(String address,
+ int port) |
+
static RedisCredentials |
+of(String address,
+ int port,
+ String password) |
+
String |
+toString() |
+
public static RedisCredentials of(@Nonnull + String address, + int port, + @Nullable + String password)+
public static RedisCredentials of(@Nonnull + String address, + int port)+
public static RedisCredentials fromConfig(@Nonnull + org.bukkit.configuration.ConfigurationSection config)+
public int getPort()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/RedisProvider.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/RedisProvider.html new file mode 100644 index 00000000..8466cab0 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/RedisProvider.html @@ -0,0 +1,284 @@ + + + + + + +public interface RedisProvider
+HelperRedis instances.| Modifier and Type | +Method and Description | +
|---|---|
RedisCredentials |
+getGlobalCredentials()
+Gets the global redis credentials being used for the global redis instance.
+ |
+
HelperRedis |
+getRedis()
+Gets the global redis instance.
+ |
+
HelperRedis |
+getRedis(RedisCredentials credentials)
+Constructs a new redis instance using the given credentials.
+ |
+
@Nonnull +HelperRedis getRedis()+
@Nonnull +HelperRedis getRedis(@Nonnull + RedisCredentials credentials)+
These instances are not cached, and a new redis instance is created each + time this method is called.
credentials - the credentials for the redis instance@Nonnull +RedisCredentials getGlobalCredentials()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/HelperRedis.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/HelperRedis.html new file mode 100644 index 00000000..19964f32 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/HelperRedis.html @@ -0,0 +1,217 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.redis | ++ |
| me.lucko.helper.redis.plugin | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
HelperRedis |
+RedisProvider.getRedis()
+Gets the global redis instance.
+ |
+
HelperRedis |
+RedisProvider.getRedis(RedisCredentials credentials)
+Constructs a new redis instance using the given credentials.
+ |
+
static HelperRedis |
+HelperRedis.usingJedis(RedisCredentials credentials) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JedisWrapper |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperRedis |
+RedisPlugin.getRedis() |
+
HelperRedis |
+RedisPlugin.getRedis(RedisCredentials credentials) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/RedisCredentials.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/RedisCredentials.html new file mode 100644 index 00000000..cde2a67a --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/RedisCredentials.html @@ -0,0 +1,248 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.redis | ++ |
| me.lucko.helper.redis.plugin | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static RedisCredentials |
+RedisCredentials.fromConfig(org.bukkit.configuration.ConfigurationSection config) |
+
RedisCredentials |
+RedisProvider.getGlobalCredentials()
+Gets the global redis credentials being used for the global redis instance.
+ |
+
static RedisCredentials |
+RedisCredentials.of(String address,
+ int port) |
+
static RedisCredentials |
+RedisCredentials.of(String address,
+ int port,
+ String password) |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperRedis |
+RedisProvider.getRedis(RedisCredentials credentials)
+Constructs a new redis instance using the given credentials.
+ |
+
static HelperRedis |
+HelperRedis.usingJedis(RedisCredentials credentials) |
+
| Modifier and Type | +Method and Description | +
|---|---|
RedisCredentials |
+RedisPlugin.getGlobalCredentials() |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperRedis |
+RedisPlugin.getRedis(RedisCredentials credentials) |
+
| Constructor and Description | +
|---|
JedisWrapper(RedisCredentials credentials) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/RedisProvider.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/RedisProvider.html new file mode 100644 index 00000000..75778fe6 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/class-use/RedisProvider.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.redis.plugin | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+RedisPlugin |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/package-frame.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/package-frame.html new file mode 100644 index 00000000..2a267046 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Interface | +Description | +
|---|---|
| HelperRedis | +
+ Represents an individual redis instance, created by the library.
+ |
+
| RedisProvider | +
+ Provides
+HelperRedis instances. |
+
| Class | +Description | +
|---|---|
| RedisCredentials | +
+ Represents the credentials for a remote redis instance.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/package-tree.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/package-tree.html new file mode 100644 index 00000000..a553316a --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/package-use.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/package-use.html new file mode 100644 index 00000000..39f933c8 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/package-use.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.redis | ++ |
| me.lucko.helper.redis.plugin | ++ |
| Class and Description | +
|---|
| HelperRedis
+ Represents an individual redis instance, created by the library.
+ |
+
| RedisCredentials
+ Represents the credentials for a remote redis instance.
+ |
+
| Class and Description | +
|---|
| HelperRedis
+ Represents an individual redis instance, created by the library.
+ |
+
| RedisCredentials
+ Represents the credentials for a remote redis instance.
+ |
+
| RedisProvider
+ Provides
+HelperRedis instances. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/JedisWrapper.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/JedisWrapper.html new file mode 100644 index 00000000..4da631ff --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/JedisWrapper.html @@ -0,0 +1,389 @@ + + + + + + +public class JedisWrapper +extends Object +implements HelperRedis+
EMPTY| Constructor and Description | +
|---|
JedisWrapper(RedisCredentials credentials) |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> me.lucko.helper.messaging.Channel<T> |
+getChannel(String name,
+ com.google.common.reflect.TypeToken<T> type) |
+
redis.clients.jedis.Jedis |
+getJedis()
+Gets a Jedis instance from the JedisPool.
+ |
+
redis.clients.jedis.JedisPool |
+getJedisPool()
+Gets the JedisPool instance backing the redis instance
+ |
+
boolean |
+terminate() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitusingJedisbindWith, hasTerminated, ofgetChannel, getChannelpublic JedisWrapper(@Nonnull + RedisCredentials credentials)+
@Nonnull +public redis.clients.jedis.JedisPool getJedisPool()+
HelperRedisgetJedisPool in interface HelperRedis@Nonnull +public redis.clients.jedis.Jedis getJedis()+
HelperRedisgetJedis in interface HelperRedispublic boolean terminate()+
terminate in interface me.lucko.helper.terminable.TerminableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/RedisPlugin.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/RedisPlugin.html new file mode 100644 index 00000000..2523aae8 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/RedisPlugin.html @@ -0,0 +1,396 @@ + + + + + + +public class RedisPlugin +extends me.lucko.helper.plugin.ExtendedJavaPlugin +implements RedisProvider+
| Constructor and Description | +
|---|
RedisPlugin() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+enable() |
+
RedisCredentials |
+getGlobalCredentials()
+Gets the global redis credentials being used for the global redis instance.
+ |
+
HelperRedis |
+getRedis()
+Gets the global redis instance.
+ |
+
HelperRedis |
+getRedis(RedisCredentials credentials)
+Constructs a new redis instance using the given credentials.
+ |
+
bind, bindComposite, bindRunnable, disable, getBundledFile, getPlugin, getService, load, loadConfig, onDisable, onEnable, onLoad, provideService, provideService, registerCommand, registerListenergetClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toStringequals, getName, hashCodeprotected void enable()+
enable in class me.lucko.helper.plugin.ExtendedJavaPlugin@Nonnull +public HelperRedis getRedis()+
RedisProvidergetRedis in interface RedisProvider@Nonnull +public HelperRedis getRedis(@Nonnull + RedisCredentials credentials)+
RedisProviderThese instances are not cached, and a new redis instance is created each + time this method is called.
getRedis in interface RedisProvidercredentials - the credentials for the redis instance@Nonnull +public RedisCredentials getGlobalCredentials()+
RedisProvidergetGlobalCredentials in interface RedisProviderCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/class-use/JedisWrapper.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/class-use/JedisWrapper.html new file mode 100644 index 00000000..03c689de --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/class-use/JedisWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/class-use/RedisPlugin.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/class-use/RedisPlugin.html new file mode 100644 index 00000000..044c938a --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/class-use/RedisPlugin.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-frame.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-frame.html new file mode 100644 index 00000000..283b9885 --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| JedisWrapper | ++ |
| RedisPlugin | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-tree.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-tree.html new file mode 100644 index 00000000..d9a785cc --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-use.html b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-use.html new file mode 100644 index 00000000..cbb744bf --- /dev/null +++ b/docs/javadoc/helper-redis/me/lucko/helper/redis/plugin/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/overview-frame.html b/docs/javadoc/helper-redis/overview-frame.html new file mode 100644 index 00000000..0b8890c8 --- /dev/null +++ b/docs/javadoc/helper-redis/overview-frame.html @@ -0,0 +1,23 @@ + + + + + + ++ + diff --git a/docs/javadoc/helper-redis/overview-summary.html b/docs/javadoc/helper-redis/overview-summary.html new file mode 100644 index 00000000..bf84a49d --- /dev/null +++ b/docs/javadoc/helper-redis/overview-summary.html @@ -0,0 +1,144 @@ + + + + + + +
| Package | +Description | +
|---|---|
| me.lucko.helper.redis | ++ |
| me.lucko.helper.redis.plugin | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/overview-tree.html b/docs/javadoc/helper-redis/overview-tree.html new file mode 100644 index 00000000..dff4bd82 --- /dev/null +++ b/docs/javadoc/helper-redis/overview-tree.html @@ -0,0 +1,168 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-redis/package-list b/docs/javadoc/helper-redis/package-list new file mode 100644 index 00000000..730ba2ed --- /dev/null +++ b/docs/javadoc/helper-redis/package-list @@ -0,0 +1,2 @@ +me.lucko.helper.redis +me.lucko.helper.redis.plugin diff --git a/docs/javadoc/helper-redis/resources/fonts/dejavu.css b/docs/javadoc/helper-redis/resources/fonts/dejavu.css new file mode 100644 index 00000000..82b867f5 --- /dev/null +++ b/docs/javadoc/helper-redis/resources/fonts/dejavu.css @@ -0,0 +1 @@ +h1{font-family:"Dejavu Sans";font-size:24px;font-style:normal;font-variant:normal;font-weight:500;line-height:26.4px;}h3{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:500;line-height:15.4px;}p{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:400;line-height:20px;}blockquote{font-family:"Dejavu Sans";font-size:21px;font-style:normal;font-variant:normal;font-weight:400;line-height:30px;}pre{font-family:"Dejavu Sans";font-size:13px;font-style:normal;font-variant:normal;font-weight:400;line-height:18.5714px;} diff --git a/docs/javadoc/helper-redis/script.js b/docs/javadoc/helper-redis/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadoc/helper-redis/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadoc/helper-redis/stylesheet.css b/docs/javadoc/helper-redis/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadoc/helper-redis/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/docs/javadoc/helper-sql/allclasses-frame.html b/docs/javadoc/helper-sql/allclasses-frame.html new file mode 100644 index 00000000..59688252 --- /dev/null +++ b/docs/javadoc/helper-sql/allclasses-frame.html @@ -0,0 +1,24 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/deprecated-list.html b/docs/javadoc/helper-sql/deprecated-list.html new file mode 100644 index 00000000..220f8d7b --- /dev/null +++ b/docs/javadoc/helper-sql/deprecated-list.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/help-doc.html b/docs/javadoc/helper-sql/help-doc.html new file mode 100644 index 00000000..c1e5853f --- /dev/null +++ b/docs/javadoc/helper-sql/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/index-all.html b/docs/javadoc/helper-sql/index-all.html new file mode 100644 index 00000000..23242f42 --- /dev/null +++ b/docs/javadoc/helper-sql/index-all.html @@ -0,0 +1,263 @@ + + + + + + +HelperDataSource instances.Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/index.html b/docs/javadoc/helper-sql/index.html new file mode 100644 index 00000000..4b4db037 --- /dev/null +++ b/docs/javadoc/helper-sql/index.html @@ -0,0 +1,76 @@ + + + + + + +public final class DatabaseCredentials +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
static DatabaseCredentials |
+fromConfig(org.bukkit.configuration.ConfigurationSection config) |
+
String |
+getAddress() |
+
String |
+getDatabase() |
+
String |
+getPassword() |
+
int |
+getPort() |
+
String |
+getUsername() |
+
int |
+hashCode() |
+
static DatabaseCredentials |
+of(String address,
+ int port,
+ String database,
+ String username,
+ String password) |
+
String |
+toString() |
+
@Nonnull +public static DatabaseCredentials of(@Nonnull + String address, + int port, + @Nonnull + String database, + @Nonnull + String username, + @Nonnull + String password)+
@Nonnull +public static DatabaseCredentials fromConfig(@Nonnull + org.bukkit.configuration.ConfigurationSection config)+
public int getPort()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/HelperDataSource.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/HelperDataSource.html new file mode 100644 index 00000000..f561b641 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/HelperDataSource.html @@ -0,0 +1,304 @@ + + + + + + +public interface HelperDataSource
+extends me.lucko.helper.terminable.Terminable
+EMPTY| Modifier and Type | +Method and Description | +
|---|---|
Connection |
+getConnection()
+Gets a connection from the datasource.
+ |
+
com.zaxxer.hikari.HikariDataSource |
+getHikari()
+Gets the Hikari instance backing the datasource
+ |
+
static HelperDataSource |
+usingHikari(DatabaseCredentials credentials) |
+
bindWith, hasTerminated, of, terminate@Nonnull +static HelperDataSource usingHikari(@Nonnull + DatabaseCredentials credentials)+
@Nonnull +com.zaxxer.hikari.HikariDataSource getHikari()+
@Nonnull +Connection getConnection() + throws SQLException+
The connection should be returned once it has been used.
SQLExceptionCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/SqlProvider.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/SqlProvider.html new file mode 100644 index 00000000..081da88e --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/SqlProvider.html @@ -0,0 +1,284 @@ + + + + + + +public interface SqlProvider
+HelperDataSource instances.| Modifier and Type | +Method and Description | +
|---|---|
HelperDataSource |
+getDataSource()
+Gets the global datasource.
+ |
+
HelperDataSource |
+getDataSource(DatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
DatabaseCredentials |
+getGlobalCredentials()
+Gets the global database credentials being used for the global datasource.
+ |
+
@Nonnull +HelperDataSource getDataSource()+
@Nonnull +HelperDataSource getDataSource(@Nonnull + DatabaseCredentials credentials)+
These instances are not cached, and a new datasource is created each + time this method is called.
credentials - the credentials for the database@Nonnull +DatabaseCredentials getGlobalCredentials()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/DatabaseCredentials.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/DatabaseCredentials.html new file mode 100644 index 00000000..40aff0d3 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/DatabaseCredentials.html @@ -0,0 +1,245 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.sql | ++ |
| me.lucko.helper.sql.plugin | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static DatabaseCredentials |
+DatabaseCredentials.fromConfig(org.bukkit.configuration.ConfigurationSection config) |
+
DatabaseCredentials |
+SqlProvider.getGlobalCredentials()
+Gets the global database credentials being used for the global datasource.
+ |
+
static DatabaseCredentials |
+DatabaseCredentials.of(String address,
+ int port,
+ String database,
+ String username,
+ String password) |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperDataSource |
+SqlProvider.getDataSource(DatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
static HelperDataSource |
+HelperDataSource.usingHikari(DatabaseCredentials credentials) |
+
| Modifier and Type | +Method and Description | +
|---|---|
DatabaseCredentials |
+SqlPlugin.getGlobalCredentials() |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperDataSource |
+SqlPlugin.getDataSource(DatabaseCredentials credentials) |
+
| Constructor and Description | +
|---|
HikariWrapper(DatabaseCredentials credentials) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/HelperDataSource.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/HelperDataSource.html new file mode 100644 index 00000000..de857575 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/HelperDataSource.html @@ -0,0 +1,217 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.sql | ++ |
| me.lucko.helper.sql.plugin | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
HelperDataSource |
+SqlProvider.getDataSource()
+Gets the global datasource.
+ |
+
HelperDataSource |
+SqlProvider.getDataSource(DatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
static HelperDataSource |
+HelperDataSource.usingHikari(DatabaseCredentials credentials) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+HikariWrapper |
+
| Modifier and Type | +Method and Description | +
|---|---|
HelperDataSource |
+SqlPlugin.getDataSource() |
+
HelperDataSource |
+SqlPlugin.getDataSource(DatabaseCredentials credentials) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/SqlProvider.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/SqlProvider.html new file mode 100644 index 00000000..63c75c30 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/class-use/SqlProvider.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.sql.plugin | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SqlPlugin |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/package-frame.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/package-frame.html new file mode 100644 index 00000000..1bba9ce0 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Interface | +Description | +
|---|---|
| HelperDataSource | +
+ Represents an individual datasource, created by the library.
+ |
+
| SqlProvider | +
+ Provides
+HelperDataSource instances. |
+
| Class | +Description | +
|---|---|
| DatabaseCredentials | +
+ Represents the credentials for a remote database.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/package-tree.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/package-tree.html new file mode 100644 index 00000000..1054aef1 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/package-use.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/package-use.html new file mode 100644 index 00000000..d37e41b6 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/package-use.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.sql | ++ |
| me.lucko.helper.sql.plugin | ++ |
| Class and Description | +
|---|
| DatabaseCredentials
+ Represents the credentials for a remote database.
+ |
+
| HelperDataSource
+ Represents an individual datasource, created by the library.
+ |
+
| Class and Description | +
|---|
| DatabaseCredentials
+ Represents the credentials for a remote database.
+ |
+
| HelperDataSource
+ Represents an individual datasource, created by the library.
+ |
+
| SqlProvider
+ Provides
+HelperDataSource instances. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/HikariWrapper.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/HikariWrapper.html new file mode 100644 index 00000000..01eecb51 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/HikariWrapper.html @@ -0,0 +1,365 @@ + + + + + + +public class HikariWrapper +extends Object +implements HelperDataSource+
EMPTY| Constructor and Description | +
|---|
HikariWrapper(DatabaseCredentials credentials) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Connection |
+getConnection()
+Gets a connection from the datasource.
+ |
+
com.zaxxer.hikari.HikariDataSource |
+getHikari()
+Gets the Hikari instance backing the datasource
+ |
+
boolean |
+terminate() |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitusingHikaribindWith, hasTerminated, ofpublic HikariWrapper(@Nonnull + DatabaseCredentials credentials)+
@Nonnull +public com.zaxxer.hikari.HikariDataSource getHikari()+
HelperDataSourcegetHikari in interface HelperDataSource@Nonnull +public Connection getConnection() + throws SQLException+
HelperDataSourceThe connection should be returned once it has been used.
getConnection in interface HelperDataSourceSQLExceptionpublic boolean terminate()+
terminate in interface me.lucko.helper.terminable.TerminableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/SqlPlugin.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/SqlPlugin.html new file mode 100644 index 00000000..e45b3c66 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/SqlPlugin.html @@ -0,0 +1,399 @@ + + + + + + +@MavenLibrary(groupId="org.slf4j", + artifactId="slf4j-api", + version="1.7.25") +public class SqlPlugin +extends me.lucko.helper.plugin.ExtendedJavaPlugin +implements SqlProvider+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+enable() |
+
HelperDataSource |
+getDataSource()
+Gets the global datasource.
+ |
+
HelperDataSource |
+getDataSource(DatabaseCredentials credentials)
+Constructs a new datasource using the given credentials.
+ |
+
DatabaseCredentials |
+getGlobalCredentials()
+Gets the global database credentials being used for the global datasource.
+ |
+
bind, bindComposite, bindRunnable, disable, getBundledFile, getPlugin, getService, load, loadConfig, onDisable, onEnable, onLoad, provideService, provideService, registerCommand, registerListenergetClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toStringequals, getName, hashCodeprotected void enable()+
enable in class me.lucko.helper.plugin.ExtendedJavaPlugin@Nonnull +public HelperDataSource getDataSource()+
SqlProvidergetDataSource in interface SqlProvider@Nonnull +public HelperDataSource getDataSource(@Nonnull + DatabaseCredentials credentials)+
SqlProviderThese instances are not cached, and a new datasource is created each + time this method is called.
getDataSource in interface SqlProvidercredentials - the credentials for the database@Nonnull +public DatabaseCredentials getGlobalCredentials()+
SqlProvidergetGlobalCredentials in interface SqlProviderCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/class-use/HikariWrapper.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/class-use/HikariWrapper.html new file mode 100644 index 00000000..8f853d88 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/class-use/HikariWrapper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/class-use/SqlPlugin.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/class-use/SqlPlugin.html new file mode 100644 index 00000000..b720dbb0 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/class-use/SqlPlugin.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-frame.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-frame.html new file mode 100644 index 00000000..7f113fb7 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| HikariWrapper | ++ |
| SqlPlugin | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-tree.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-tree.html new file mode 100644 index 00000000..2c9b5ed3 --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-use.html b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-use.html new file mode 100644 index 00000000..47c8a22e --- /dev/null +++ b/docs/javadoc/helper-sql/me/lucko/helper/sql/plugin/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/overview-frame.html b/docs/javadoc/helper-sql/overview-frame.html new file mode 100644 index 00000000..b31f9ce9 --- /dev/null +++ b/docs/javadoc/helper-sql/overview-frame.html @@ -0,0 +1,23 @@ + + + + + + ++ + diff --git a/docs/javadoc/helper-sql/overview-summary.html b/docs/javadoc/helper-sql/overview-summary.html new file mode 100644 index 00000000..b206d369 --- /dev/null +++ b/docs/javadoc/helper-sql/overview-summary.html @@ -0,0 +1,144 @@ + + + + + + +
| Package | +Description | +
|---|---|
| me.lucko.helper.sql | ++ |
| me.lucko.helper.sql.plugin | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/overview-tree.html b/docs/javadoc/helper-sql/overview-tree.html new file mode 100644 index 00000000..da171acb --- /dev/null +++ b/docs/javadoc/helper-sql/overview-tree.html @@ -0,0 +1,163 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper-sql/package-list b/docs/javadoc/helper-sql/package-list new file mode 100644 index 00000000..886e203d --- /dev/null +++ b/docs/javadoc/helper-sql/package-list @@ -0,0 +1,2 @@ +me.lucko.helper.sql +me.lucko.helper.sql.plugin diff --git a/docs/javadoc/helper-sql/resources/fonts/dejavu.css b/docs/javadoc/helper-sql/resources/fonts/dejavu.css new file mode 100644 index 00000000..82b867f5 --- /dev/null +++ b/docs/javadoc/helper-sql/resources/fonts/dejavu.css @@ -0,0 +1 @@ +h1{font-family:"Dejavu Sans";font-size:24px;font-style:normal;font-variant:normal;font-weight:500;line-height:26.4px;}h3{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:500;line-height:15.4px;}p{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:400;line-height:20px;}blockquote{font-family:"Dejavu Sans";font-size:21px;font-style:normal;font-variant:normal;font-weight:400;line-height:30px;}pre{font-family:"Dejavu Sans";font-size:13px;font-style:normal;font-variant:normal;font-weight:400;line-height:18.5714px;} diff --git a/docs/javadoc/helper-sql/script.js b/docs/javadoc/helper-sql/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadoc/helper-sql/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadoc/helper-sql/stylesheet.css b/docs/javadoc/helper-sql/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadoc/helper-sql/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/docs/javadoc/helper/allclasses-frame.html b/docs/javadoc/helper/allclasses-frame.html new file mode 100644 index 00000000..afe3a5e7 --- /dev/null +++ b/docs/javadoc/helper/allclasses-frame.html @@ -0,0 +1,124 @@ + + + + + + +| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final int |
+DEFAULT_LINES |
+6 |
+
| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+ALL_SERVERS |
+"ALL" |
+
+
+public static final String |
+ONLINE_SERVERS |
+"ONLINE" |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/deprecated-list.html b/docs/javadoc/helper/deprecated-list.html new file mode 100644 index 00000000..4431a33c --- /dev/null +++ b/docs/javadoc/helper/deprecated-list.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/help-doc.html b/docs/javadoc/helper/help-doc.html new file mode 100644 index 00000000..403cb711 --- /dev/null +++ b/docs/javadoc/helper/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/index-all.html b/docs/javadoc/helper/index-all.html new file mode 100644 index 00000000..0d0d8342 --- /dev/null +++ b/docs/javadoc/helper/index-all.html @@ -0,0 +1,3453 @@ + + + + + + +Messenger.SchemeMapping using an immutable map.Gui using the next available slot in the populatorGui using the next available slot in the populatorStream API.Channels message streams.Terminable.hasTerminated()Commands.FunctionalCommandCommands.FunctionalCommandTerminables, to be easily registered as one.CompositeTerminables.Events.HandlerBuilder.filter(Predicate).Events.HandlerEvents.MergedHandlerOptional containing the argument if presentFileStorageHandler implemented using Gson.Commands.CommandBuilder into a Commands.FunctionalCommand instance.Bukkit.getServer() for convenience.Collector using Guava's immutable collections.Gui.Item instances.ItemStack instancesJsonArray builder utilityJsonObject builder utilityMavenLibrary annotations for a class, and loads the dependency
+ into the classloader.MavenLibrary annotations on the given object.MavenLibrary annotations on the given class.Bukkit.getLogger()GuiChannels.MetadataMaps bound to players, entities, blocks and worlds.MetadataMap.MetadataKeys, and maps them to persistent or transient (expiring / weak) values.ChannelAgent for this channel.JsonNull.PaginatedGui.PaginatedGui.Gui using the next available slot in the populatorPlugin annotation and generates a plugin.yml file.ServicePriority.Normal.MenuSchemeScoreboard.Scoreboard.Gui.SoftReferenceSchemeMappings.Terminables.Terminables.TimingManagerMetadataMap which will automatically expire at some point.WeakReferenceCooldown.test() returns true.Cooldown.test() returns true.Cooldown.test() returns true.Cooldown.test() returns true.Cooldown.test() returns true.Cooldown.test() returns true.Cooldown.test() returns true.Cooldown.test() returns true.Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/index.html b/docs/javadoc/helper/index.html new file mode 100644 index 00000000..3aa77207 --- /dev/null +++ b/docs/javadoc/helper/index.html @@ -0,0 +1,76 @@ + + + + + + +T - the sender type@NonnullByDefault +public static interface Commands.CommandBuilder<T extends CommandSender>+
Commands.FunctionalCommand| Modifier and Type | +Method and Description | +
|---|---|
default Commands.CommandBuilder<T> |
+assertArgument(int index,
+ Predicate<String> test)
+Tests a given argument with the provided predicate.
+ |
+
Commands.CommandBuilder<T> |
+assertArgument(int index,
+ Predicate<String> test,
+ String failureMessage)
+Tests a given argument with the provided predicate.
+ |
+
default Commands.CommandBuilder<ConsoleCommandSender> |
+assertConsole()
+Asserts that the sender is instance of ConsoleCommandSender, and sends them the default failure message if
+ they're not.
+ |
+
Commands.CommandBuilder<ConsoleCommandSender> |
+assertConsole(String failureMessage)
+Asserts that the sender is instance of ConsoleCommandSender, and sends them the failure message if they're not
+ |
+
default Commands.CommandBuilder<T> |
+assertOp()
+Asserts that the sender is op, and sends them the default failure message if they're not.
+ |
+
Commands.CommandBuilder<T> |
+assertOp(String failureMessage)
+Asserts that the sender is op, and sends them the failure message if they don't have permission
+ |
+
default Commands.CommandBuilder<T> |
+assertPermission(String permission)
+Asserts that the sender has the specified permission, and sends them the default failure message
+ if they don't have permission.
+ |
+
Commands.CommandBuilder<T> |
+assertPermission(String permission,
+ String failureMessage)
+Asserts that the sender has the specified permission, and sends them the failure message if they
+ don't have permission.
+ |
+
default Commands.CommandBuilder<Player> |
+assertPlayer()
+Asserts that the sender is instance of Player, and sends them the default failure message if they're not.
+ |
+
Commands.CommandBuilder<Player> |
+assertPlayer(String failureMessage)
+Asserts that the sender is instance of Player, and sends them the failure message if they're not
+ |
+
default Commands.CommandBuilder<T> |
+assertSender(Predicate<T> test)
+Tests the sender with the provided predicate.
+ |
+
Commands.CommandBuilder<T> |
+assertSender(Predicate<T> test,
+ String failureMessage)
+Tests the sender with the provided predicate.
+ |
+
default Commands.CommandBuilder<T> |
+assertUsage(String usage)
+Asserts that the arguments match the given usage string.
+ |
+
Commands.CommandBuilder<T> |
+assertUsage(String usage,
+ String failureMessage)
+Asserts that the arguments match the given usage string.
+ |
+
Commands.FunctionalCommand |
+handler(Commands.CommandHandler<T> handler)
+Builds this
+Commands.CommandBuilder into a Commands.FunctionalCommand instance. |
+
default Commands.CommandBuilder<T> |
+withCooldown(Cooldown cooldown)
+Tests the command attempt against the given cooldown.
+ |
+
default Commands.CommandBuilder<T> |
+withCooldown(CooldownCollection<T> cooldown)
+Tests the command attempt against the given cooldown.
+ |
+
Commands.CommandBuilder<T> |
+withCooldown(CooldownCollection<T> cooldown,
+ String failureMessage)
+Tests the command attempt against the given cooldown.
+ |
+
Commands.CommandBuilder<T> |
+withCooldown(Cooldown cooldown,
+ String failureMessage)
+Tests the command attempt against the given cooldown.
+ |
+
default Commands.CommandBuilder<T> assertPermission(String permission)+
permission - the permission to check forCommands.CommandBuilder<T> assertPermission(String permission, + String failureMessage)+
permission - the permission to check forfailureMessage - the failure message to send if they don't have permissiondefault Commands.CommandBuilder<T> assertOp()+
Commands.CommandBuilder<T> assertOp(String failureMessage)+
failureMessage - the failure message to send if they're not opdefault Commands.CommandBuilder<Player> assertPlayer()+
Commands.CommandBuilder<Player> assertPlayer(String failureMessage)+
failureMessage - the failure message to send if they're not a playerdefault Commands.CommandBuilder<ConsoleCommandSender> assertConsole()+
Commands.CommandBuilder<ConsoleCommandSender> assertConsole(String failureMessage)+
failureMessage - the failure message to send if they're not consoledefault Commands.CommandBuilder<T> assertUsage(String usage)+
usage - the usage stringCommands.CommandBuilder<T> assertUsage(String usage, + String failureMessage)+
usage - the usage stringfailureMessage - the failure message to send if the arguments to not match the usagedefault Commands.CommandBuilder<T> assertArgument(int index, + Predicate<String> test)+
null is passed to the predicate.index - the index of the argument to testtest - the test predicateCommands.CommandBuilder<T> assertArgument(int index, + Predicate<String> test, + String failureMessage)+
null is passed to the predicate.
+
+ "{arg}" and "{index}" will be replaced in the failure message with the index and actual argument value respectively.index - the index of the argument to testtest - the test predicatefailureMessage - the failure message to send if the predicate failsdefault Commands.CommandBuilder<T> assertSender(Predicate<T> test)+
test - the test predicateCommands.CommandBuilder<T> assertSender(Predicate<T> test, + String failureMessage)+
test - the test predicatefailureMessage - the failure message to send if the predicate failsdefault Commands.CommandBuilder<T> withCooldown(Cooldown cooldown)+
cooldown - the cooldownCommands.CommandBuilder<T> withCooldown(Cooldown cooldown, + String failureMessage)+
cooldown - the cooldownfailureMessage - the failure message to send if cooldown failsdefault Commands.CommandBuilder<T> withCooldown(CooldownCollection<T> cooldown)+
cooldown - the cooldownCommands.CommandBuilder<T> withCooldown(CooldownCollection<T> cooldown, + String failureMessage)+
cooldown - the cooldownfailureMessage - the failure message to send if cooldown failsCommands.FunctionalCommand handler(Commands.CommandHandler<T> handler)+
Commands.CommandBuilder into a Commands.FunctionalCommand instance.
+
+ The command will not be registered with the server until Commands.FunctionalCommand.register(ExtendedJavaPlugin, String...) is called.handler - the command handlerCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Commands.CommandContext.html b/docs/javadoc/helper/me/lucko/helper/Commands.CommandContext.html new file mode 100644 index 00000000..7ce627d6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Commands.CommandContext.html @@ -0,0 +1,325 @@ + + + + + + +T - the sender type@NonnullByDefault +public static interface Commands.CommandContext<T extends CommandSender>+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getArg(int index)
+Gets the argument at the given index.
+ |
+
default Optional<String> |
+getArgIfPresent(int index)
+Returns a
+Optional containing the argument if present |
+
ImmutableList<String> |
+getArgs()
+Gets an immutable list of the supplied arguments
+ |
+
String |
+getLabel()
+Gets the command label which was used to execute this command
+ |
+
T |
+getSender()
+Gets the sender who executed the command
+ |
+
T getSender()+
ImmutableList<String> getArgs()+
@Nullable +String getArg(int index)+
index - the indexdefault Optional<String> getArgIfPresent(int index)+
Optional containing the argument if presentindex - the indexString getLabel()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Commands.CommandHandler.html b/docs/javadoc/helper/me/lucko/helper/Commands.CommandHandler.html new file mode 100644 index 00000000..b1259441 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Commands.CommandHandler.html @@ -0,0 +1,245 @@ + + + + + + +T - the sender type@FunctionalInterface + @NonnullByDefault +public static interface Commands.CommandHandler<T extends CommandSender>+
Commands.FunctionalCommand| Modifier and Type | +Method and Description | +
|---|---|
void |
+handle(Commands.CommandContext<T> c)
+Executes the handler using the given command context
+ |
+
void handle(Commands.CommandContext<T> c)+
c - the command contextCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Commands.FunctionalCommand.html b/docs/javadoc/helper/me/lucko/helper/Commands.FunctionalCommand.html new file mode 100644 index 00000000..ce5b9cde --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Commands.FunctionalCommand.html @@ -0,0 +1,259 @@ + + + + + + +@NonnullByDefault +public static interface Commands.FunctionalCommand+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+handle(Commands.CommandContext<?> context)
+Calls the command handler
+ |
+
void |
+register(ExtendedJavaPlugin plugin,
+ String... aliases)
+Registers this command with the server, via the given plugin instance
+ |
+
void register(ExtendedJavaPlugin plugin, + String... aliases)+
plugin - the plugin instancealiases - the aliases for the commandvoid handle(Commands.CommandContext<?> context)+
context - the contexts for the commandCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Commands.html b/docs/javadoc/helper/me/lucko/helper/Commands.html new file mode 100644 index 00000000..06416cdb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Commands.html @@ -0,0 +1,375 @@ + + + + + + +@NonnullByDefault +public final class Commands +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static interface |
+Commands.CommandBuilder<T extends CommandSender>
+Builds a
+Commands.FunctionalCommand |
+
static interface |
+Commands.CommandContext<T extends CommandSender>
+Represents the context for a command call
+ |
+
static interface |
+Commands.CommandHandler<T extends CommandSender>
+Represents a handler for a
+Commands.FunctionalCommand |
+
static interface |
+Commands.FunctionalCommand
+Represents a command built from functional predicate calls
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static Predicate<String> |
+ASSERTION_DOUBLE |
+
static Predicate<String> |
+ASSERTION_INTEGER |
+
static Predicate<String> |
+ASSERTION_OFFLINE_PLAYER |
+
static Predicate<String> |
+ASSERTION_ONLINE_PLAYER |
+
static Predicate<String> |
+ASSERTION_UUID |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Commands.CommandBuilder<CommandSender> |
+create()
+Creates and returns a new command builder
+ |
+
public static Commands.CommandBuilder<CommandSender> create()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Events.DefaultFilters.html b/docs/javadoc/helper/me/lucko/helper/Events.DefaultFilters.html new file mode 100644 index 00000000..52593f7e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Events.DefaultFilters.html @@ -0,0 +1,378 @@ + + + + + + +@NonnullByDefault +public static interface Events.DefaultFilters+
Events.HandlerBuilder.filter(Predicate).| Modifier and Type | +Method and Description | +
|---|---|
<T extends EntityEvent> |
+entityHasMetadata(MetadataKey<?> key)
+Returns a predicate which only returns true if the entity has a given metadata key
+ |
+
<T extends Cancellable> |
+ignoreCancelled()
+Returns a predicate which only returns true if the event isn't cancelled
+ |
+
<T extends PlayerMoveEvent> |
+ignoreSameBlock()
+Returns a predicate which only returns true if the player has moved over a block
+ |
+
<T extends PlayerMoveEvent> |
+ignoreSameBlockAndY()
+Returns a predicate which only returns true if the player has moved over a block, not including movement
+ directly up and down.
+ |
+
<T extends PlayerMoveEvent> |
+ignoreSameChunk()
+Returns a predicate which only returns true if the player has moved over a chunk border
+ |
+
<T extends PlayerEvent> |
+playerHasMetadata(MetadataKey<?> key)
+Returns a predicate which only returns true if the player has a given metadata key
+ |
+
<T extends PlayerEvent> |
+playerHasPermission(String permission)
+Returns a predicate which only returns true if the player has the given permission
+ |
+
<T extends Cancellable> Predicate<T> ignoreCancelled()+
T - the event type<T extends PlayerMoveEvent> Predicate<T> ignoreSameBlock()+
T - the event type<T extends PlayerMoveEvent> Predicate<T> ignoreSameBlockAndY()+
T - the event type<T extends PlayerMoveEvent> Predicate<T> ignoreSameChunk()+
T - the event type<T extends EntityEvent> Predicate<T> entityHasMetadata(MetadataKey<?> key)+
T - the event typekey - the metadata key<T extends PlayerEvent> Predicate<T> playerHasMetadata(MetadataKey<?> key)+
T - the event typekey - the metadata key<T extends PlayerEvent> Predicate<T> playerHasPermission(String permission)+
T - the event typepermission - the permissionCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Events.Handler.html b/docs/javadoc/helper/me/lucko/helper/Events.Handler.html new file mode 100644 index 00000000..6453cbba --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Events.Handler.html @@ -0,0 +1,370 @@ + + + + + + +T - the event type@NonnullByDefault +public static interface Events.Handler<T> +extends Terminable+
EMPTY| Modifier and Type | +Method and Description | +
|---|---|
long |
+getCallCounter()
+Gets the number of times the handler has been called
+ |
+
Class<T> |
+getEventClass()
+Gets the class the handler is handling
+ |
+
OptionalLong |
+getExpiryTimeMillis()
+Gets the time in milliseconds when this handler will expire, if any
+ |
+
boolean |
+isActive()
+Gets whether the handler is active
+ |
+
default boolean |
+terminate()
+Terminate this instance
+ |
+
boolean |
+unregister()
+Unregisters the handler
+ |
+
bindWith, hasTerminated, ofClass<T> getEventClass()+
boolean isActive()+
long getCallCounter()+
OptionalLong getExpiryTimeMillis()+
boolean unregister()+
default boolean terminate()+
Terminableterminate in interface TerminableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Events.HandlerBuilder.html b/docs/javadoc/helper/me/lucko/helper/Events.HandlerBuilder.html new file mode 100644 index 00000000..b3fb9506 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Events.HandlerBuilder.html @@ -0,0 +1,467 @@ + + + + + + +T - the event type@NonnullByDefault +public static interface Events.HandlerBuilder<T extends Event>+
Events.Handler| Modifier and Type | +Method and Description | +
|---|---|
Events.HandlerBuilder<T> |
+exceptionConsumer(BiConsumer<? super T,Throwable> consumer)
+Sets the exception consumer for the handler.
+ |
+
Events.HandlerBuilder<T> |
+expireAfter(long maxCalls)
+Sets the number of calls until the handler will automatically be unregistered
+ |
+
Events.HandlerBuilder<T> |
+expireAfter(long duration,
+ TimeUnit unit)
+Sets the expiry time on the handler
+ |
+
Events.HandlerBuilder<T> |
+filter(Predicate<T> predicate)
+Adds a filter to the handler.
+ |
+
Events.Handler<T> |
+handler(BiConsumer<Events.Handler<T>,? super T> handler)
+Builds and registers the Handler.
+ |
+
default Events.Handler<T> |
+handler(Consumer<? super T> handler)
+Builds and registers the Handler.
+ |
+
Events.HandlerBuilder<T> |
+withCooldown(Cooldown cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+withCooldown(CooldownCollection<? super T> cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> expireAfter(long duration, + TimeUnit unit)+
duration - the duration until expiryunit - the unit for the durationIllegalArgumentException - if duration is not greater than or equal to 1Events.HandlerBuilder<T> expireAfter(long maxCalls)+
The call counter is only incremented if the event call passes all filters and if the handler completes + without throwing an exception.
maxCalls - the number of times the handler will be called until being unregistered.IllegalArgumentException - if maxCalls is not greater than or equal to 1Events.HandlerBuilder<T> exceptionConsumer(BiConsumer<? super T,Throwable> consumer)+
If an exception is thrown in the handler, it is passed to this consumer to be swallowed.
consumer - the consumerNullPointerException - if the consumer is nullEvents.HandlerBuilder<T> filter(Predicate<T> predicate)+
An event will only be handled if it passes all filters. Filters are evaluated in the order they are + registered.
predicate - the filterEvents.HandlerBuilder<T> withCooldown(Cooldown cooldown)+
Cooldown.test() returns true.cooldown - the cooldownEvents.HandlerBuilder<T> withCooldown(Cooldown cooldown, + BiConsumer<Cooldown,? super T> cooldownFailConsumer)+
Cooldown.test() returns true.cooldown - the cooldowncooldownFailConsumer - a consumer to be called when the cooldown fails.Events.HandlerBuilder<T> withCooldown(CooldownCollection<? super T> cooldown)+
Cooldown.test() returns true.cooldown - the cooldownEvents.HandlerBuilder<T> withCooldown(CooldownCollection<? super T> cooldown, + BiConsumer<Cooldown,? super T> cooldownFailConsumer)+
Cooldown.test() returns true.cooldown - the cooldowncooldownFailConsumer - a consumer to be called when the cooldown fails.default Events.Handler<T> handler(Consumer<? super T> handler)+
handler - the consumer responsible for handling the event.Events.Handler instance.NullPointerException - if the handler is nullEvents.Handler<T> handler(BiConsumer<Events.Handler<T>,? super T> handler)+
handler - the bi-consumer responsible for handling the event.Events.Handler instance.NullPointerException - if the handler is nullCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Events.MergedHandler.html b/docs/javadoc/helper/me/lucko/helper/Events.MergedHandler.html new file mode 100644 index 00000000..0d6b7e90 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Events.MergedHandler.html @@ -0,0 +1,390 @@ + + + + + + +T - the event type@NonnullByDefault +public static interface Events.MergedHandler<T> +extends Terminable+
EMPTY| Modifier and Type | +Method and Description | +
|---|---|
long |
+getCallCounter()
+Gets the number of times the handler has been called
+ |
+
Set<Class<? extends Event>> |
+getEventClasses()
+Gets a set of the individual event classes being listened to
+ |
+
OptionalLong |
+getExpiryTimeMillis()
+Gets the time in milliseconds when this handler will expire, if any
+ |
+
Class<? super T> |
+getHandledClass()
+Gets the handled class
+ |
+
boolean |
+isActive()
+Gets whether the handler is active
+ |
+
default boolean |
+terminate()
+Terminate this instance
+ |
+
boolean |
+unregister()
+Unregisters the handler
+ |
+
bindWith, hasTerminated, ofClass<? super T> getHandledClass()+
Set<Class<? extends Event>> getEventClasses()+
boolean isActive()+
long getCallCounter()+
OptionalLong getExpiryTimeMillis()+
boolean unregister()+
default boolean terminate()+
Terminableterminate in interface TerminableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Events.MergedHandlerBuilder.html b/docs/javadoc/helper/me/lucko/helper/Events.MergedHandlerBuilder.html new file mode 100644 index 00000000..ffd3a938 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Events.MergedHandlerBuilder.html @@ -0,0 +1,526 @@ + + + + + + +T - the super event type@NonnullByDefault +public static interface Events.MergedHandlerBuilder<T>+
Events.MergedHandler| Modifier and Type | +Method and Description | +
|---|---|
<E extends Event> |
+bindEvent(Class<E> eventClass,
+ EventPriority priority,
+ Function<E,T> function)
+Binds this handler to an event
+ |
+
<E extends Event> |
+bindEvent(Class<E> eventClass,
+ Function<E,T> function)
+Binds this handler to an event
+ |
+
Events.MergedHandlerBuilder<T> |
+exceptionConsumer(BiConsumer<Event,Throwable> consumer)
+Sets the exception consumer for the handler.
+ |
+
Events.MergedHandlerBuilder<T> |
+expireAfter(long maxCalls)
+Sets the number of calls until the handler will automatically be unregistered
+ |
+
Events.MergedHandlerBuilder<T> |
+expireAfter(long duration,
+ TimeUnit unit)
+Sets the expiry time on the handler
+ |
+
Events.MergedHandlerBuilder<T> |
+filter(Predicate<T> predicate)
+Adds a filter to the handler.
+ |
+
Events.MergedHandler<T> |
+handler(BiConsumer<Events.MergedHandler<T>,? super T> handler)
+Builds and registers the Handler.
+ |
+
default Events.MergedHandler<T> |
+handler(Consumer<? super T> handler)
+Builds and registers the Handler.
+ |
+
Events.MergedHandlerBuilder<T> |
+withCooldown(Cooldown cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+withCooldown(CooldownCollection<? super T> cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
<E extends Event> Events.MergedHandlerBuilder<T> bindEvent(Class<E> eventClass, + Function<E,T> function)+
E - the event classeventClass - the event class to bind tofunction - the function to remap the event<E extends Event> Events.MergedHandlerBuilder<T> bindEvent(Class<E> eventClass, + EventPriority priority, + Function<E,T> function)+
E - the event classeventClass - the event class to bind topriority - the priority to listen atfunction - the function to remap the eventEvents.MergedHandlerBuilder<T> expireAfter(long duration, + TimeUnit unit)+
duration - the duration until expiryunit - the unit for the durationIllegalArgumentException - if duration is not greater than or equal to 1Events.MergedHandlerBuilder<T> expireAfter(long maxCalls)+
The call counter is only incremented if the event call passes all filters and if the handler completes + without throwing an exception.
maxCalls - the number of times the handler will be called until being unregistered.IllegalArgumentException - if maxCalls is not greater than or equal to 1Events.MergedHandlerBuilder<T> exceptionConsumer(BiConsumer<Event,Throwable> consumer)+
If an exception is thrown in the handler, it is passed to this consumer to be swallowed.
consumer - the consumerNullPointerException - if the consumer is nullEvents.MergedHandlerBuilder<T> filter(Predicate<T> predicate)+
An event will only be handled if it passes all filters. Filters are evaluated in the order they are + registered.
predicate - the filterEvents.MergedHandlerBuilder<T> withCooldown(Cooldown cooldown)+
Cooldown.test() returns true.cooldown - the cooldownEvents.MergedHandlerBuilder<T> withCooldown(Cooldown cooldown, + BiConsumer<Cooldown,? super T> cooldownFailConsumer)+
Cooldown.test() returns true.cooldown - the cooldowncooldownFailConsumer - a consumer to be called when the cooldown fails.Events.MergedHandlerBuilder<T> withCooldown(CooldownCollection<? super T> cooldown)+
Cooldown.test() returns true.cooldown - the cooldownEvents.MergedHandlerBuilder<T> withCooldown(CooldownCollection<? super T> cooldown, + BiConsumer<Cooldown,? super T> cooldownFailConsumer)+
Cooldown.test() returns true.cooldown - the cooldowncooldownFailConsumer - a consumer to be called when the cooldown fails.default Events.MergedHandler<T> handler(Consumer<? super T> handler)+
handler - the consumer responsible for handling the event.Events.Handler instance.NullPointerException - if the handler is nullIllegalStateException - if no events have been bound toEvents.MergedHandler<T> handler(BiConsumer<Events.MergedHandler<T>,? super T> handler)+
handler - the bi-consumer responsible for handling the event.Events.Handler instance.NullPointerException - if the handler is nullIllegalStateException - if no events have been bound toCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Events.html b/docs/javadoc/helper/me/lucko/helper/Events.html new file mode 100644 index 00000000..83e60a56 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Events.html @@ -0,0 +1,531 @@ + + + + + + +@NonnullByDefault +public final class Events +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static interface |
+Events.DefaultFilters
+Provides a set of useful default filters for passing to
+Events.HandlerBuilder.filter(Predicate). |
+
static interface |
+Events.Handler<T>
+Responsible for the handling of a given event
+ |
+
static interface |
+Events.HandlerBuilder<T extends Event>
+Builds a
+Events.Handler |
+
static interface |
+Events.MergedHandler<T>
+Responsible for the handling of a merged event
+ |
+
static interface |
+Events.MergedHandlerBuilder<T>
+Builds a
+Events.MergedHandler |
+
| Modifier and Type | +Field and Description | +
|---|---|
static Events.DefaultFilters |
+DEFAULT_FILTERS |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+call(Event event)
+Submit the event on the current thread
+ |
+
static void |
+callAsync(Event event)
+Submit the event on a new async thread.
+ |
+
static void |
+callSync(Event event)
+Submit the event on the main server thread.
+ |
+
static <S extends Event> |
+merge(Class<S> superClass,
+ Class<? extends S>... eventClasses)
+Makes a MergedHandlerBuilder for a super event class
+ |
+
static <S extends Event> |
+merge(Class<S> superClass,
+ EventPriority priority,
+ Class<? extends S>... eventClasses)
+Makes a MergedHandlerBuilder for a super event class
+ |
+
static <T> Events.MergedHandlerBuilder<T> |
+merge(Class<T> handledClass)
+Makes a MergedHandlerBuilder for a given super type
+ |
+
static <T> Events.MergedHandlerBuilder<T> |
+merge(TypeToken<T> type)
+Makes a MergedHandlerBuilder for a given super type
+ |
+
static <T extends Event> |
+subscribe(Class<T> eventClass)
+Makes a HandlerBuilder for a given event
+ |
+
static <T extends Event> |
+subscribe(Class<T> eventClass,
+ EventPriority priority)
+Makes a HandlerBuilder for a given event
+ |
+
public static final Events.DefaultFilters DEFAULT_FILTERS+
public static <T extends Event> Events.HandlerBuilder<T> subscribe(Class<T> eventClass)+
T - the event typeeventClass - the class of the eventEvents.HandlerBuilder to construct the event handlerNullPointerException - if eventClass is nullpublic static <T extends Event> Events.HandlerBuilder<T> subscribe(Class<T> eventClass, + EventPriority priority)+
T - the event typeeventClass - the class of the eventpriority - the priority to listen atEvents.HandlerBuilder to construct the event handlerNullPointerException - if eventClass or priority is nullpublic static <T> Events.MergedHandlerBuilder<T> merge(Class<T> handledClass)+
T - the super type classhandledClass - the super type of the event handlerEvents.MergedHandlerBuilder to construct the event handlerpublic static <T> Events.MergedHandlerBuilder<T> merge(TypeToken<T> type)+
T - the super type classtype - the super type of the event handlerEvents.MergedHandlerBuilder to construct the event handler@SafeVarargs +public static <S extends Event> Events.MergedHandlerBuilder<S> merge(Class<S> superClass, + Class<? extends S>... eventClasses)+
S - the super class typesuperClass - the abstract super event classeventClasses - the event classes to be bound toEvents.MergedHandlerBuilder to construct the event handler@SafeVarargs +public static <S extends Event> Events.MergedHandlerBuilder<S> merge(Class<S> superClass, + EventPriority priority, + Class<? extends S>... eventClasses)+
S - the super class typesuperClass - the abstract super event classpriority - the priority to listen ateventClasses - the event classes to be bound toEvents.MergedHandlerBuilder to construct the event handlerpublic static void call(Event event)+
event - the event to callpublic static void callAsync(Event event)+
event - the event to callpublic static void callSync(Event event)+
event - the event to callCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Helper.html b/docs/javadoc/helper/me/lucko/helper/Helper.html new file mode 100644 index 00000000..29377b9f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Helper.html @@ -0,0 +1,380 @@ + + + + + + +@NonnullByDefault +public final class Helper +extends Object+
Bukkit.getServer() for convenience.| Modifier and Type | +Method and Description | +
|---|---|
static BukkitScheduler |
+bukkitScheduler() |
+
static ConsoleCommandSender |
+console() |
+
static void |
+executeCommand(String command) |
+
static JavaPlugin |
+hostPlugin()
+Gets the plugin which is "hosting" helper.
+ |
+
static PluginManager |
+plugins() |
+
static Server |
+server() |
+
static <T> Optional<T> |
+service(Class<T> clazz) |
+
static <T> T |
+serviceNullable(Class<T> clazz) |
+
static ServicesManager |
+services() |
+
static Optional<World> |
+world(String name) |
+
static World |
+worldNullable(String name) |
+
public static JavaPlugin hostPlugin()+
public static Server server()+
public static ConsoleCommandSender console()+
public static PluginManager plugins()+
public static ServicesManager services()+
public static BukkitScheduler bukkitScheduler()+
public static void executeCommand(String command)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Scheduler.Task.html b/docs/javadoc/helper/me/lucko/helper/Scheduler.Task.html new file mode 100644 index 00000000..10996e7a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Scheduler.Task.html @@ -0,0 +1,303 @@ + + + + + + +@NonnullByDefault +public static interface Scheduler.Task +extends Terminable+
EMPTY| Modifier and Type | +Method and Description | +
|---|---|
int |
+getBukkitId()
+Gets the Bukkit ID for this task
+ |
+
int |
+getTimesRan()
+Gets the number of times this task has ran.
+ |
+
boolean |
+stop()
+Stops the task
+ |
+
bindWith, hasTerminated, of, terminateint getTimesRan()+
boolean stop()+
int getBukkitId()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/Scheduler.html b/docs/javadoc/helper/me/lucko/helper/Scheduler.html new file mode 100644 index 00000000..1723e93c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/Scheduler.html @@ -0,0 +1,756 @@ + + + + + + +@NonnullByDefault +public final class Scheduler +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static interface |
+Scheduler.Task
+Represents a scheduled repeating task
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Executor |
+async()
+Get an Executor instance which will execute all passed runnables using a thread pool
+ |
+
static BukkitScheduler |
+bukkit() |
+
static Executor |
+bukkitAsync()
+Get an Executor instance which will execute all passed runnables using the Bukkit scheduler thread pool
+
+ Does not allow tasks to be posted if the backing plugin is not enabled.
+ |
+
static <T> CompletableFuture<T> |
+callAsync(Callable<T> callable)
+Call a callable asynchronously
+ |
+
static <T> CompletableFuture<T> |
+callLaterAsync(Callable<T> callable,
+ long delay)
+Call a callable asynchronously at some point in the future
+ |
+
static <T> CompletableFuture<T> |
+callLaterSync(Callable<T> callable,
+ long delay)
+Call a callable on the main thread at some point in the future
+ |
+
static <T> CompletableFuture<T> |
+callSync(Callable<T> callable)
+Call a callable on the main server thread
+ |
+
static ExecutorService |
+internalAsync()
+Get an Executor instance which will execute all passed runnables using an internal thread pool
+ |
+
static CompletableFuture<Void> |
+runAsync(Runnable runnable)
+Execute a runnable asynchronously
+ |
+
static CompletableFuture<Void> |
+runLaterAsync(Runnable runnable,
+ long delay)
+Execute a runnable asynchronously at some point in the future
+ |
+
static CompletableFuture<Void> |
+runLaterSync(Runnable runnable,
+ long delay)
+Execute a runnable on the main server thread at some point in the future
+ |
+
static CompletableFuture<Void> |
+runSync(Runnable runnable)
+Execute a runnable on the main server thread
+ |
+
static Scheduler.Task |
+runTaskRepeatingAsync(Consumer<Scheduler.Task> consumer,
+ long delay,
+ long interval)
+Schedule a repeating task to run asynchronously
+ |
+
static Scheduler.Task |
+runTaskRepeatingAsync(Runnable runnable,
+ long delay,
+ long interval)
+Schedule a repeating task to run asynchronously
+ |
+
static Scheduler.Task |
+runTaskRepeatingSync(Consumer<Scheduler.Task> consumer,
+ long delay,
+ long interval)
+Schedule a repeating task to run on the main server thread
+ |
+
static Scheduler.Task |
+runTaskRepeatingSync(Runnable runnable,
+ long delay,
+ long interval)
+Schedule a repeating task to run on the main server thread
+ |
+
static <T> CompletableFuture<T> |
+supplyAsync(Supplier<T> supplier)
+Compute the result of the passed supplier asynchronously
+ |
+
static <T> CompletableFuture<T> |
+supplyLaterAsync(Supplier<T> supplier,
+ long delay)
+Compute the result of the passed supplier asynchronously at some point in the future
+ |
+
static <T> CompletableFuture<T> |
+supplyLaterSync(Supplier<T> supplier,
+ long delay)
+Compute the result of the passed supplier on the main thread at some point in the future
+ |
+
static <T> CompletableFuture<T> |
+supplySync(Supplier<T> supplier)
+Compute the result of the passed supplier on the main thread
+ |
+
static Executor |
+sync()
+Get an Executor instance which will execute all passed runnables on the main server thread.
+ |
+
public static Executor sync()+
public static Executor bukkitAsync()+
public static ExecutorService internalAsync()+
public static Executor async()+
public static BukkitScheduler bukkit()+
public static <T> CompletableFuture<T> supplySync(Supplier<T> supplier)+
T - the return typesupplier - the supplierpublic static <T> CompletableFuture<T> supplyAsync(Supplier<T> supplier)+
T - the return typesupplier - the supplierpublic static <T> CompletableFuture<T> callSync(Callable<T> callable)+
T - the return typecallable - the callablepublic static <T> CompletableFuture<T> callAsync(Callable<T> callable)+
T - the return typecallable - the callablepublic static CompletableFuture<Void> runSync(Runnable runnable)+
runnable - the runnablepublic static CompletableFuture<Void> runAsync(Runnable runnable)+
runnable - the runnablepublic static <T> CompletableFuture<T> supplyLaterSync(Supplier<T> supplier, + long delay)+
T - the return typesupplier - the supplierdelay - the delay in ticks before calling the supplierpublic static <T> CompletableFuture<T> supplyLaterAsync(Supplier<T> supplier, + long delay)+
T - the return typesupplier - the supplierdelay - the delay in ticks before calling the supplierpublic static <T> CompletableFuture<T> callLaterSync(Callable<T> callable, + long delay)+
T - the return typecallable - the callabledelay - the delay in ticks before calling the supplierpublic static <T> CompletableFuture<T> callLaterAsync(Callable<T> callable, + long delay)+
T - the return typecallable - the callabledelay - the delay in ticks before calling the supplierpublic static CompletableFuture<Void> runLaterSync(Runnable runnable, + long delay)+
runnable - the runnabledelay - the delay in ticks before calling the supplierpublic static CompletableFuture<Void> runLaterAsync(Runnable runnable, + long delay)+
runnable - the runnabledelay - the delay in ticks before calling the supplierpublic static Scheduler.Task runTaskRepeatingSync(Consumer<Scheduler.Task> consumer, + long delay, + long interval)+
consumer - the task to rundelay - the delay before the task beginsinterval - the interval at which the task will repeatpublic static Scheduler.Task runTaskRepeatingAsync(Consumer<Scheduler.Task> consumer, + long delay, + long interval)+
consumer - the task to rundelay - the delay before the task beginsinterval - the interval at which the task will repeatpublic static Scheduler.Task runTaskRepeatingSync(Runnable runnable, + long delay, + long interval)+
runnable - the task to rundelay - the delay before the task beginsinterval - the interval at which the task will repeatpublic static Scheduler.Task runTaskRepeatingAsync(Runnable runnable, + long delay, + long interval)+
runnable - the task to rundelay - the delay before the task beginsinterval - the interval at which the task will repeatCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandBuilder.html b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandBuilder.html new file mode 100644 index 00000000..80f15982 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandBuilder.html @@ -0,0 +1,287 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertArgument(int index,
+ Predicate<String> test)
+Tests a given argument with the provided predicate.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertArgument(int index,
+ Predicate<String> test,
+ String failureMessage)
+Tests a given argument with the provided predicate.
+ |
+
default Commands.CommandBuilder<ConsoleCommandSender> |
+Commands.CommandBuilder.assertConsole()
+Asserts that the sender is instance of ConsoleCommandSender, and sends them the default failure message if
+ they're not.
+ |
+
Commands.CommandBuilder<ConsoleCommandSender> |
+Commands.CommandBuilder.assertConsole(String failureMessage)
+Asserts that the sender is instance of ConsoleCommandSender, and sends them the failure message if they're not
+ |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertOp()
+Asserts that the sender is op, and sends them the default failure message if they're not.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertOp(String failureMessage)
+Asserts that the sender is op, and sends them the failure message if they don't have permission
+ |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertPermission(String permission)
+Asserts that the sender has the specified permission, and sends them the default failure message
+ if they don't have permission.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertPermission(String permission,
+ String failureMessage)
+Asserts that the sender has the specified permission, and sends them the failure message if they
+ don't have permission.
+ |
+
default Commands.CommandBuilder<Player> |
+Commands.CommandBuilder.assertPlayer()
+Asserts that the sender is instance of Player, and sends them the default failure message if they're not.
+ |
+
Commands.CommandBuilder<Player> |
+Commands.CommandBuilder.assertPlayer(String failureMessage)
+Asserts that the sender is instance of Player, and sends them the failure message if they're not
+ |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertSender(Predicate<T> test)
+Tests the sender with the provided predicate.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertSender(Predicate<T> test,
+ String failureMessage)
+Tests the sender with the provided predicate.
+ |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertUsage(String usage)
+Asserts that the arguments match the given usage string.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.assertUsage(String usage,
+ String failureMessage)
+Asserts that the arguments match the given usage string.
+ |
+
static Commands.CommandBuilder<CommandSender> |
+Commands.create()
+Creates and returns a new command builder
+ |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(Cooldown cooldown)
+Tests the command attempt against the given cooldown.
+ |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(CooldownCollection<T> cooldown)
+Tests the command attempt against the given cooldown.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(CooldownCollection<T> cooldown,
+ String failureMessage)
+Tests the command attempt against the given cooldown.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(Cooldown cooldown,
+ String failureMessage)
+Tests the command attempt against the given cooldown.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandContext.html b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandContext.html new file mode 100644 index 00000000..655d8b8c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandContext.html @@ -0,0 +1,174 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Commands.FunctionalCommand.handle(Commands.CommandContext<?> context)
+Calls the command handler
+ |
+
void |
+Commands.CommandHandler.handle(Commands.CommandContext<T> c)
+Executes the handler using the given command context
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandHandler.html b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandHandler.html new file mode 100644 index 00000000..78290160 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.CommandHandler.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Commands.FunctionalCommand |
+Commands.CommandBuilder.handler(Commands.CommandHandler<T> handler)
+Builds this
+Commands.CommandBuilder into a Commands.FunctionalCommand instance. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Commands.FunctionalCommand.html b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.FunctionalCommand.html new file mode 100644 index 00000000..0829bcea --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.FunctionalCommand.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Commands.FunctionalCommand |
+Commands.CommandBuilder.handler(Commands.CommandHandler<T> handler)
+Builds this
+Commands.CommandBuilder into a Commands.FunctionalCommand instance. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Commands.html b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.html new file mode 100644 index 00000000..c8c03511 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Commands.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Events.DefaultFilters.html b/docs/javadoc/helper/me/lucko/helper/class-use/Events.DefaultFilters.html new file mode 100644 index 00000000..bbdf4bbd --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Events.DefaultFilters.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static Events.DefaultFilters |
+Events.DEFAULT_FILTERS |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Events.Handler.html b/docs/javadoc/helper/me/lucko/helper/class-use/Events.Handler.html new file mode 100644 index 00000000..cdaf1fbb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Events.Handler.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Events.Handler<T> |
+Events.HandlerBuilder.handler(BiConsumer<Events.Handler<T>,? super T> handler)
+Builds and registers the Handler.
+ |
+
default Events.Handler<T> |
+Events.HandlerBuilder.handler(Consumer<? super T> handler)
+Builds and registers the Handler.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Events.Handler<T> |
+Events.HandlerBuilder.handler(BiConsumer<Events.Handler<T>,? super T> handler)
+Builds and registers the Handler.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Events.HandlerBuilder.html b/docs/javadoc/helper/me/lucko/helper/class-use/Events.HandlerBuilder.html new file mode 100644 index 00000000..411e44bc --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Events.HandlerBuilder.html @@ -0,0 +1,226 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.exceptionConsumer(BiConsumer<? super T,Throwable> consumer)
+Sets the exception consumer for the handler.
+ |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.expireAfter(long maxCalls)
+Sets the number of calls until the handler will automatically be unregistered
+ |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.expireAfter(long duration,
+ TimeUnit unit)
+Sets the expiry time on the handler
+ |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.filter(Predicate<T> predicate)
+Adds a filter to the handler.
+ |
+
static <T extends Event> |
+Events.subscribe(Class<T> eventClass)
+Makes a HandlerBuilder for a given event
+ |
+
static <T extends Event> |
+Events.subscribe(Class<T> eventClass,
+ EventPriority priority)
+Makes a HandlerBuilder for a given event
+ |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(Cooldown cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Events.MergedHandler.html b/docs/javadoc/helper/me/lucko/helper/class-use/Events.MergedHandler.html new file mode 100644 index 00000000..6c7936fb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Events.MergedHandler.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Events.MergedHandler<T> |
+Events.MergedHandlerBuilder.handler(BiConsumer<Events.MergedHandler<T>,? super T> handler)
+Builds and registers the Handler.
+ |
+
default Events.MergedHandler<T> |
+Events.MergedHandlerBuilder.handler(Consumer<? super T> handler)
+Builds and registers the Handler.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Events.MergedHandler<T> |
+Events.MergedHandlerBuilder.handler(BiConsumer<Events.MergedHandler<T>,? super T> handler)
+Builds and registers the Handler.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Events.MergedHandlerBuilder.html b/docs/javadoc/helper/me/lucko/helper/class-use/Events.MergedHandlerBuilder.html new file mode 100644 index 00000000..b1900238 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Events.MergedHandlerBuilder.html @@ -0,0 +1,255 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
<E extends Event> |
+Events.MergedHandlerBuilder.bindEvent(Class<E> eventClass,
+ EventPriority priority,
+ Function<E,T> function)
+Binds this handler to an event
+ |
+
<E extends Event> |
+Events.MergedHandlerBuilder.bindEvent(Class<E> eventClass,
+ Function<E,T> function)
+Binds this handler to an event
+ |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.exceptionConsumer(BiConsumer<Event,Throwable> consumer)
+Sets the exception consumer for the handler.
+ |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.expireAfter(long maxCalls)
+Sets the number of calls until the handler will automatically be unregistered
+ |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.expireAfter(long duration,
+ TimeUnit unit)
+Sets the expiry time on the handler
+ |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.filter(Predicate<T> predicate)
+Adds a filter to the handler.
+ |
+
static <S extends Event> |
+Events.merge(Class<S> superClass,
+ Class<? extends S>... eventClasses)
+Makes a MergedHandlerBuilder for a super event class
+ |
+
static <S extends Event> |
+Events.merge(Class<S> superClass,
+ EventPriority priority,
+ Class<? extends S>... eventClasses)
+Makes a MergedHandlerBuilder for a super event class
+ |
+
static <T> Events.MergedHandlerBuilder<T> |
+Events.merge(Class<T> handledClass)
+Makes a MergedHandlerBuilder for a given super type
+ |
+
static <T> Events.MergedHandlerBuilder<T> |
+Events.merge(TypeToken<T> type)
+Makes a MergedHandlerBuilder for a given super type
+ |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(Cooldown cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Events.html b/docs/javadoc/helper/me/lucko/helper/class-use/Events.html new file mode 100644 index 00000000..afc3c3a3 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Events.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Helper.html b/docs/javadoc/helper/me/lucko/helper/class-use/Helper.html new file mode 100644 index 00000000..c3af958c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Helper.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Scheduler.Task.html b/docs/javadoc/helper/me/lucko/helper/class-use/Scheduler.Task.html new file mode 100644 index 00000000..c41951a4 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Scheduler.Task.html @@ -0,0 +1,219 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Scheduler.Task |
+Scheduler.runTaskRepeatingAsync(Consumer<Scheduler.Task> consumer,
+ long delay,
+ long interval)
+Schedule a repeating task to run asynchronously
+ |
+
static Scheduler.Task |
+Scheduler.runTaskRepeatingAsync(Runnable runnable,
+ long delay,
+ long interval)
+Schedule a repeating task to run asynchronously
+ |
+
static Scheduler.Task |
+Scheduler.runTaskRepeatingSync(Consumer<Scheduler.Task> consumer,
+ long delay,
+ long interval)
+Schedule a repeating task to run on the main server thread
+ |
+
static Scheduler.Task |
+Scheduler.runTaskRepeatingSync(Runnable runnable,
+ long delay,
+ long interval)
+Schedule a repeating task to run on the main server thread
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Scheduler.Task |
+Scheduler.runTaskRepeatingAsync(Consumer<Scheduler.Task> consumer,
+ long delay,
+ long interval)
+Schedule a repeating task to run asynchronously
+ |
+
static Scheduler.Task |
+Scheduler.runTaskRepeatingSync(Consumer<Scheduler.Task> consumer,
+ long delay,
+ long interval)
+Schedule a repeating task to run on the main server thread
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/class-use/Scheduler.html b/docs/javadoc/helper/me/lucko/helper/class-use/Scheduler.html new file mode 100644 index 00000000..5165cbbb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/class-use/Scheduler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/Numbers.html b/docs/javadoc/helper/me/lucko/helper/function/Numbers.html new file mode 100644 index 00000000..cd13f573 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/Numbers.html @@ -0,0 +1,468 @@ + + + + + + +public final class Numbers +extends Object+ +
| Modifier and Type | +Method and Description | +
|---|---|
static Optional<Number> |
+parse(String s) |
+
static Byte |
+parseByteNullable(String s) |
+
static Optional<Byte> |
+parseByteOpt(String s) |
+
static OptionalDouble |
+parseDouble(String s) |
+
static Double |
+parseDoubleNullable(String s) |
+
static Optional<Double> |
+parseDoubleOpt(String s) |
+
static OptionalDouble |
+parseFloat(String s) |
+
static Float |
+parseFloatNullable(String s) |
+
static Optional<Float> |
+parseFloatOpt(String s) |
+
static OptionalInt |
+parseInteger(String s) |
+
static Integer |
+parseIntegerNullable(String s) |
+
static Optional<Integer> |
+parseIntegerOpt(String s) |
+
static OptionalLong |
+parseLong(String s) |
+
static Long |
+parseLongNullable(String s) |
+
static Optional<Long> |
+parseLongOpt(String s) |
+
static Number |
+parseNullable(String s) |
+
@Nullable +public static Integer parseIntegerNullable(@Nonnull + String s)+
@Nonnull +public static Optional<Integer> parseIntegerOpt(@Nonnull + String s)+
@Nonnull +public static OptionalInt parseInteger(@Nonnull + String s)+
@Nonnull +public static OptionalLong parseLong(@Nonnull + String s)+
@Nonnull +public static OptionalDouble parseFloat(@Nonnull + String s)+
@Nullable +public static Double parseDoubleNullable(@Nonnull + String s)+
@Nonnull +public static OptionalDouble parseDouble(@Nonnull + String s)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/chain/Chain.html b/docs/javadoc/helper/me/lucko/helper/function/chain/Chain.html new file mode 100644 index 00000000..64d32b72 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/chain/Chain.html @@ -0,0 +1,671 @@ + + + + + + +T - the object type@NonnullByDefault +public interface Chain<T>+
Stream API.
+
+ Chains are not threadsafe or immutable, and should not be reused. + They are intended only as a way to reduce boilerplate.
+ +Unlike Streams, Chains are only able to process one object.
| Modifier and Type | +Method and Description | +
|---|---|
Chain<T> |
+apply(Consumer<? super T> action)
+Applies an action to the backing object
+ |
+
Chain<T> |
+applyIf(Predicate<? super T> test,
+ Consumer<? super T> action)
+Applies an action to the backing object if the test passes.
+ |
+
Chain<T> |
+applyIfNonNull(Consumer<? super T> action)
+Applies an action to the backing object, if the object is not null.
+ |
+
Optional<T> |
+end()
+Gets an optional containing the object backing this chain.
+ |
+
T |
+endOrNull()
+Gets the object, or null.
+ |
+
<R> Chain<R> |
+flatMap(Function<? super T,? extends Chain<? extends R>> mapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation.
+ |
+
<R> Chain<R> |
+ifElse(Predicate<? super T> test,
+ R passValue,
+ R failValue)
+Returns a new chain instance containing a new value, depending on if the current
+ object passed the given test.
+ |
+
<R> Chain<R> |
+map(Function<? super T,? extends R> mapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation.
+ |
+
<R> Chain<R> |
+mapNullSafe(Function<? super T,? extends R> nonNullMapper,
+ R otherValue)
+Transforms the backing object and returns a new chain instance
+ containing the result of the transformation, if the backing object is
+ not null.
+ |
+
<R> Chain<R> |
+mapNullSafeGet(Function<? super T,? extends R> nonNullMapper,
+ Supplier<? extends R> nullSupplier)
+Transforms the backing object and returns a new chain instance
+ containing the result of the transformation, if the backing object is
+ not null.
+ |
+
<R> Chain<R> |
+mapOrElse(Predicate<? super T> test,
+ Function<? super T,? extends R> passedMapper,
+ Function<? super T,? extends R> failedMapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the chosen transformation function.
+ |
+
<R> Chain<R> |
+mapOrElse(Predicate<? super T> test,
+ Function<? super T,? extends R> passedMapper,
+ R otherValue)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation function, if the test is passed.
+ |
+
Chain<T> |
+orElse(Predicate<? super T> test,
+ T failValue)
+Updates the backing object if the test fails, otherwise returns an identical chain.
+ |
+
Chain<T> |
+orElseGet(Predicate<? super T> test,
+ Supplier<? extends T> failSupplier)
+Updates the backing object if the test fails, otherwise returns an identical chain.
+ |
+
Chain<T> |
+orElseGetIfNull(Supplier<? extends T> supplier)
+Updates the backing object if it is null, otherwise returns an identical chain.
+ |
+
Chain<T> |
+orElseIfNull(T otherValue)
+Updates the backing object if it is null, otherwise returns an identical chain.
+ |
+
static <T> Chain<T> |
+start(T object)
+Creates a new chain
+ |
+
static <T> Chain<T> start(@Nullable + T object)+
T - the object typeobject - the initial objectChain<T> apply(Consumer<? super T> action)+
action - the action to applyChain<T> applyIf(Predicate<? super T> test, + Consumer<? super T> action)+
test - the testaction - the action to applyChain<T> applyIfNonNull(Consumer<? super T> action)+
action - the action to applyChain<T> orElse(Predicate<? super T> test, + T failValue)+
failValue - the fail valueChain<T> orElseIfNull(T otherValue)+
otherValue - the other valueChain<T> orElseGet(Predicate<? super T> test, + Supplier<? extends T> failSupplier)+
failSupplier - the fail supplierChain<T> orElseGetIfNull(Supplier<? extends T> supplier)+
supplier - the null supplier<R> Chain<R> ifElse(Predicate<? super T> test, + R passValue, + R failValue)+
R - the resultant chain typetest - the testpassValue - the value to use if the object passesfailValue - the value to use if the object fails<R> Chain<R> map(Function<? super T,? extends R> mapper)+
R - the resultant chain typemapper - the mapping function<R> Chain<R> mapOrElse(Predicate<? super T> test, + Function<? super T,? extends R> passedMapper, + R otherValue)+
R - the resultant chain typetest - the testpassedMapper - the function to use if the object passes the testotherValue - the value to use if the object fails the test<R> Chain<R> mapOrElse(Predicate<? super T> test, + Function<? super T,? extends R> passedMapper, + Function<? super T,? extends R> failedMapper)+
R - the resultant chain typetest - the testpassedMapper - the function to use if the object passes the testfailedMapper - the function to use if the object fails the test<R> Chain<R> mapNullSafe(Function<? super T,? extends R> nonNullMapper, + R otherValue)+
R - the resultant chain typenonNullMapper - the function to use if the object is not nullotherValue - the value to use if the object is null<R> Chain<R> mapNullSafeGet(Function<? super T,? extends R> nonNullMapper, + Supplier<? extends R> nullSupplier)+
R - the resultant chain typenonNullMapper - the function to use if the object is not nullnullSupplier - the supplier to use if the object is null<R> Chain<R> flatMap(Function<? super T,? extends Chain<? extends R>> mapper)+
R - the resultant chain typemapper - the mapping functionOptional<T> end()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/chain/class-use/Chain.html b/docs/javadoc/helper/me/lucko/helper/function/chain/class-use/Chain.html new file mode 100644 index 00000000..3b8233c8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/chain/class-use/Chain.html @@ -0,0 +1,288 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.function.chain | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Chain<T> |
+Chain.apply(Consumer<? super T> action)
+Applies an action to the backing object
+ |
+
Chain<T> |
+Chain.applyIf(Predicate<? super T> test,
+ Consumer<? super T> action)
+Applies an action to the backing object if the test passes.
+ |
+
Chain<T> |
+Chain.applyIfNonNull(Consumer<? super T> action)
+Applies an action to the backing object, if the object is not null.
+ |
+
<R> Chain<R> |
+Chain.flatMap(Function<? super T,? extends Chain<? extends R>> mapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation.
+ |
+
<R> Chain<R> |
+Chain.ifElse(Predicate<? super T> test,
+ R passValue,
+ R failValue)
+Returns a new chain instance containing a new value, depending on if the current
+ object passed the given test.
+ |
+
<R> Chain<R> |
+Chain.map(Function<? super T,? extends R> mapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation.
+ |
+
<R> Chain<R> |
+Chain.mapNullSafe(Function<? super T,? extends R> nonNullMapper,
+ R otherValue)
+Transforms the backing object and returns a new chain instance
+ containing the result of the transformation, if the backing object is
+ not null.
+ |
+
<R> Chain<R> |
+Chain.mapNullSafeGet(Function<? super T,? extends R> nonNullMapper,
+ Supplier<? extends R> nullSupplier)
+Transforms the backing object and returns a new chain instance
+ containing the result of the transformation, if the backing object is
+ not null.
+ |
+
<R> Chain<R> |
+Chain.mapOrElse(Predicate<? super T> test,
+ Function<? super T,? extends R> passedMapper,
+ Function<? super T,? extends R> failedMapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the chosen transformation function.
+ |
+
<R> Chain<R> |
+Chain.mapOrElse(Predicate<? super T> test,
+ Function<? super T,? extends R> passedMapper,
+ R otherValue)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation function, if the test is passed.
+ |
+
Chain<T> |
+Chain.orElse(Predicate<? super T> test,
+ T failValue)
+Updates the backing object if the test fails, otherwise returns an identical chain.
+ |
+
Chain<T> |
+Chain.orElseGet(Predicate<? super T> test,
+ Supplier<? extends T> failSupplier)
+Updates the backing object if the test fails, otherwise returns an identical chain.
+ |
+
Chain<T> |
+Chain.orElseGetIfNull(Supplier<? extends T> supplier)
+Updates the backing object if it is null, otherwise returns an identical chain.
+ |
+
Chain<T> |
+Chain.orElseIfNull(T otherValue)
+Updates the backing object if it is null, otherwise returns an identical chain.
+ |
+
static <T> Chain<T> |
+Chain.start(T object)
+Creates a new chain
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<R> Chain<R> |
+Chain.flatMap(Function<? super T,? extends Chain<? extends R>> mapper)
+Transforms the backing object, and returns a new chain instance
+ containing the result of the transformation.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/chain/package-frame.html b/docs/javadoc/helper/me/lucko/helper/function/chain/package-frame.html new file mode 100644 index 00000000..e53d698d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/chain/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/chain/package-tree.html b/docs/javadoc/helper/me/lucko/helper/function/chain/package-tree.html new file mode 100644 index 00000000..50c69f81 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/chain/package-tree.html @@ -0,0 +1,135 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/chain/package-use.html b/docs/javadoc/helper/me/lucko/helper/function/chain/package-use.html new file mode 100644 index 00000000..4028d3a6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/chain/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.function.chain | ++ |
| Class and Description | +
|---|
| Chain
+ A simplified version of Java 8's
+Stream API. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/class-use/Numbers.html b/docs/javadoc/helper/me/lucko/helper/function/class-use/Numbers.html new file mode 100644 index 00000000..61dd756f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/class-use/Numbers.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/package-frame.html b/docs/javadoc/helper/me/lucko/helper/function/package-frame.html new file mode 100644 index 00000000..95528805 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| Numbers | ++ + | +
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/package-tree.html b/docs/javadoc/helper/me/lucko/helper/function/package-tree.html new file mode 100644 index 00000000..0af6cb2f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/function/package-use.html b/docs/javadoc/helper/me/lucko/helper/function/package-use.html new file mode 100644 index 00000000..dfdd55b7 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/function/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/GsonProvider.html b/docs/javadoc/helper/me/lucko/helper/gson/GsonProvider.html new file mode 100644 index 00000000..fc086b24 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/GsonProvider.html @@ -0,0 +1,383 @@ + + + + + + +public final class GsonProvider +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Gson |
+get() |
+
static Gson |
+getPrettyPrinting() |
+
static JsonObject |
+readObject(Reader reader) |
+
static JsonObject |
+readObject(String s) |
+
static String |
+toString(JsonElement element) |
+
static String |
+toStringPretty(JsonElement element) |
+
static void |
+writeElement(Appendable writer,
+ JsonElement element) |
+
static void |
+writeElementPretty(Appendable writer,
+ JsonElement element) |
+
static void |
+writeObject(Appendable writer,
+ JsonObject object) |
+
static void |
+writeObjectPretty(Appendable writer,
+ JsonObject data) |
+
@Nonnull +public static JsonObject readObject(@Nonnull + Reader reader)+
@Nonnull +public static JsonObject readObject(@Nonnull + String s)+
public static void writeObject(@Nonnull + Appendable writer, + @Nonnull + JsonObject object)+
public static void writeObjectPretty(@Nonnull + Appendable writer, + @Nonnull + JsonObject data)+
public static void writeElement(@Nonnull + Appendable writer, + @Nonnull + JsonElement element)+
public static void writeElementPretty(@Nonnull + Appendable writer, + @Nonnull + JsonElement element)+
@Nonnull +public static String toString(@Nonnull + JsonElement element)+
@Nonnull +public static String toStringPretty(@Nonnull + JsonElement element)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/GsonSerializable.html b/docs/javadoc/helper/me/lucko/helper/gson/GsonSerializable.html new file mode 100644 index 00000000..1411efce --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/GsonSerializable.html @@ -0,0 +1,299 @@ + + + + + + +public interface GsonSerializable
+Classes which implement this interface should also implement a static "deserialize" method,
+ accepting JsonElement as the only parameter.
| Modifier and Type | +Method and Description | +
|---|---|
static <T extends GsonSerializable> |
+deserialize(Class<T> clazz,
+ JsonElement element)
+Deserializes a JsonElement to a GsonSerializable object.
+ |
+
static Method |
+getDeserializeMethod(Class<?> clazz)
+Gets the deserialization method for a given class.
+ |
+
JsonElement |
+serialize()
+Serializes the object to JSON
+ |
+
@Nonnull +static <T extends GsonSerializable> T deserialize(@Nonnull + Class<T> clazz, + @Nonnull + JsonElement element)+
T - the GsonSerializable typeclazz - the GsonSerializable classelement - the json element to deserializeIllegalStateException - if the clazz does not have a deserialization method@Nullable +static Method getDeserializeMethod(@Nonnull + Class<?> clazz)+
clazz - the class@Nonnull +JsonElement serialize()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/GsonSerializableAdapterFactory.html b/docs/javadoc/helper/me/lucko/helper/gson/GsonSerializableAdapterFactory.html new file mode 100644 index 00000000..8bb0219e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/GsonSerializableAdapterFactory.html @@ -0,0 +1,287 @@ + + + + + + +public final class GsonSerializableAdapterFactory +extends Object +implements TypeAdapterFactory+
| Modifier and Type | +Field and Description | +
|---|---|
static GsonSerializableAdapterFactory |
+INSTANCE |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> TypeAdapter<T> |
+create(Gson gson,
+ TypeToken<T> type) |
+
@Nonnull +public static final GsonSerializableAdapterFactory INSTANCE+
public <T> TypeAdapter<T> create(Gson gson, + TypeToken<T> type)+
create in interface TypeAdapterFactoryCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.JsonArrayBuilder.html b/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.JsonArrayBuilder.html new file mode 100644 index 00000000..cb7d9f34 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.JsonArrayBuilder.html @@ -0,0 +1,478 @@ + + + + + + +public static interface JsonBuilder.JsonArrayBuilder +extends Consumer<JsonElement>+
JsonArray builder utilitydefault void accept(JsonElement value)+
accept in interface Consumer<JsonElement>JsonBuilder.JsonArrayBuilder add(@Nullable + JsonElement value, + boolean copy)+
default JsonBuilder.JsonArrayBuilder add(@Nullable + JsonElement value)+
default JsonBuilder.JsonArrayBuilder add(@Nullable + GsonSerializable serializable)+
default JsonBuilder.JsonArrayBuilder add(@Nullable + String value)+
default JsonBuilder.JsonArrayBuilder add(@Nullable + Number value)+
default JsonBuilder.JsonArrayBuilder add(@Nullable + Boolean value)+
default JsonBuilder.JsonArrayBuilder add(@Nullable + Character value)+
default <T extends JsonElement> JsonBuilder.JsonArrayBuilder addAll(Iterable<T> iterable, + boolean copy)+
default <T extends JsonElement> JsonBuilder.JsonArrayBuilder addAll(Iterable<T> iterable)+
default <T extends JsonElement> JsonBuilder.JsonArrayBuilder addAll(Stream<T> stream, + boolean copy)+
default <T extends JsonElement> JsonBuilder.JsonArrayBuilder addAll(Stream<T> stream)+
default <T extends GsonSerializable> JsonBuilder.JsonArrayBuilder addSerializables(Iterable<T> iterable)+
default JsonBuilder.JsonArrayBuilder addStrings(Iterable<String> iterable)+
default <T extends Number> JsonBuilder.JsonArrayBuilder addNumbers(Iterable<T> iterable)+
default JsonBuilder.JsonArrayBuilder addBooleans(Iterable<Boolean> iterable)+
default JsonBuilder.JsonArrayBuilder addCharacters(Iterable<Character> iterable)+
JsonArray build()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.JsonObjectBuilder.html b/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.JsonObjectBuilder.html new file mode 100644 index 00000000..b5597e0b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.JsonObjectBuilder.html @@ -0,0 +1,809 @@ + + + + + + +public static interface JsonBuilder.JsonObjectBuilder +extends BiConsumer<String,JsonElement>, Consumer<Map.Entry<String,JsonElement>>+
JsonObject builder utilityandThendefault void accept(Map.Entry<String,JsonElement> entry)+
accept in interface Consumer<Map.Entry<String,JsonElement>>default void accept(String property, + JsonElement value)+
accept in interface BiConsumer<String,JsonElement>JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + JsonElement value, + boolean copy)+
default JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + JsonElement value)+
default JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + GsonSerializable serializable)+
default JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + String value)+
default JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + Number value)+
default JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + Boolean value)+
default JsonBuilder.JsonObjectBuilder add(String property, + @Nullable + Character value)+
JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + JsonElement value, + boolean copy)+
default JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + JsonElement value)+
default JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + GsonSerializable serializable)+
default JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + String value)+
default JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + Number value)+
default JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + Boolean value)+
default JsonBuilder.JsonObjectBuilder addIfAbsent(String property, + @Nullable + Character value)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAll(Iterable<Map.Entry<String,T>> iterable, + boolean deepCopy)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAll(Iterable<Map.Entry<String,T>> iterable)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAll(Stream<Map.Entry<String,T>> stream, + boolean deepCopy)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAll(Stream<Map.Entry<String,T>> stream)+
default JsonBuilder.JsonObjectBuilder addAll(JsonObject object, + boolean deepCopy)+
default JsonBuilder.JsonObjectBuilder addAll(JsonObject object)+
default <T extends GsonSerializable> JsonBuilder.JsonObjectBuilder addAllSerializables(Iterable<Map.Entry<String,T>> iterable)+
default JsonBuilder.JsonObjectBuilder addAllStrings(Iterable<Map.Entry<String,String>> iterable)+
default <T extends Number> JsonBuilder.JsonObjectBuilder addAllNumbers(Iterable<Map.Entry<String,T>> iterable)+
default JsonBuilder.JsonObjectBuilder addAllBooleans(Iterable<Map.Entry<String,Boolean>> iterable)+
default JsonBuilder.JsonObjectBuilder addAllCharacters(Iterable<Map.Entry<String,Character>> iterable)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAllIfAbsent(Iterable<Map.Entry<String,T>> iterable, + boolean deepCopy)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAllIfAbsent(Iterable<Map.Entry<String,T>> iterable)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAllIfAbsent(Stream<Map.Entry<String,T>> stream, + boolean deepCopy)+
default <T extends JsonElement> JsonBuilder.JsonObjectBuilder addAllIfAbsent(Stream<Map.Entry<String,T>> stream)+
default JsonBuilder.JsonObjectBuilder addAllIfAbsent(JsonObject object, + boolean deepCopy)+
default JsonBuilder.JsonObjectBuilder addAllIfAbsent(JsonObject object)+
default <T extends GsonSerializable> JsonBuilder.JsonObjectBuilder addAllSerializablesIfAbsent(Iterable<Map.Entry<String,T>> iterable)+
default JsonBuilder.JsonObjectBuilder addAllStringsIfAbsent(Iterable<Map.Entry<String,String>> iterable)+
default <T extends Number> JsonBuilder.JsonObjectBuilder addAllNumbersIfAbsent(Iterable<Map.Entry<String,T>> iterable)+
default JsonBuilder.JsonObjectBuilder addAllBooleansIfAbsent(Iterable<Map.Entry<String,Boolean>> iterable)+
default JsonBuilder.JsonObjectBuilder addAllCharactersIfAbsent(Iterable<Map.Entry<String,Character>> iterable)+
JsonObject build()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.html b/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.html new file mode 100644 index 00000000..b6d54e0f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/JsonBuilder.html @@ -0,0 +1,712 @@ + + + + + + +@NonnullByDefault +public final class JsonBuilder +extends Object+
| Modifier and Type | +Class and Description | +
|---|---|
static interface |
+JsonBuilder.JsonArrayBuilder
+A
+JsonArray builder utility |
+
static interface |
+JsonBuilder.JsonObjectBuilder
+A
+JsonObject builder utility |
+
| Modifier and Type | +Method and Description | +
|---|---|
static JsonBuilder.JsonArrayBuilder |
+array()
+Creates a new array builder, with no initial values
+ |
+
static JsonBuilder.JsonArrayBuilder |
+array(JsonArray array)
+Creates a new array builder, without copying the passed array.
+ |
+
static JsonBuilder.JsonArrayBuilder |
+array(JsonArray array,
+ boolean copy)
+Creates a new array builder
+ |
+
static Collector<GsonSerializable,JsonBuilder.JsonArrayBuilder,JsonArray> |
+collectSerializablesToArray()
+Returns a collector which forms a JsonArray from GsonSerializables
+ |
+
static Collector<JsonElement,JsonBuilder.JsonArrayBuilder,JsonArray> |
+collectToArray()
+Returns a collector which forms a JsonArray from JsonElements
+ |
+
static <T> Collector<T,JsonBuilder.JsonArrayBuilder,JsonArray> |
+collectToArray(Function<? super T,JsonElement> valueMapper)
+Returns a collector which forms a JsonArray using the value mapper
+ |
+
static <T> Collector<T,JsonBuilder.JsonObjectBuilder,JsonObject> |
+collectToObject(Function<? super T,String> keyMapper,
+ Function<? super T,JsonElement> valueMapper)
+Returns a collector which forms a JsonObject using the key and value mappers
+ |
+
static JsonNull |
+nullValue()
+Returns an instance of
+JsonNull. |
+
static JsonBuilder.JsonObjectBuilder |
+object()
+Creates a new object builder, with no initial values
+ |
+
static JsonBuilder.JsonObjectBuilder |
+object(JsonObject object)
+Creates a new object builder, without copying the passed object.
+ |
+
static JsonBuilder.JsonObjectBuilder |
+object(JsonObject object,
+ boolean copy)
+Creates a new object builder
+ |
+
static JsonElement |
+primitive(Boolean value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitive(Character value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitive(Number value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitive(String value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitiveNonNull(Boolean value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitiveNonNull(Character value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitiveNonNull(Number value)
+Creates a JsonPrimitive from the given value.
+ |
+
static JsonElement |
+primitiveNonNull(String value)
+Creates a JsonPrimitive from the given value.
+ |
+
public static JsonBuilder.JsonObjectBuilder object(JsonObject object, + boolean copy)+
If copy is not true, the passed object will be mutated by the builder methods.
object - the object to base the new builder uponcopy - if the object should be deep copied, or just referenced.public static JsonBuilder.JsonObjectBuilder object(JsonObject object)+
Equivalent to calling object(JsonObject, boolean) with copy = false.
object - the object to base the new builder uponpublic static JsonBuilder.JsonObjectBuilder object()+
public static JsonBuilder.JsonArrayBuilder array(JsonArray array, + boolean copy)+
If copy is not true, the passed array will be mutated by the builder methods.
array - the array to base the new builder uponcopy - if the array should be deep copied, or just referenced.public static JsonBuilder.JsonArrayBuilder array(JsonArray array)+
Equivalent to calling array(JsonArray, boolean) with copy = false.
array - the array to base the new builder uponpublic static JsonBuilder.JsonArrayBuilder array()+
public static JsonElement primitive(@Nullable + String value)+
If the value is null, nullValue() is returned.
value - the valuepublic static JsonElement primitive(@Nullable + Number value)+
If the value is null, nullValue() is returned.
value - the valuepublic static JsonElement primitive(@Nullable + Boolean value)+
If the value is null, nullValue() is returned.
value - the valuepublic static JsonElement primitive(@Nullable + Character value)+
If the value is null, nullValue() is returned.
value - the valuepublic static JsonNull nullValue()+
JsonNull.public static JsonElement primitiveNonNull(String value)+
If the value is null, a NullPointerException will be thrown.
value - the valueNullPointerException - if value is nullpublic static JsonElement primitiveNonNull(Number value)+
If the value is null, a NullPointerException will be thrown.
value - the valueNullPointerException - if value is nullpublic static JsonElement primitiveNonNull(Boolean value)+
If the value is null, a NullPointerException will be thrown.
value - the valueNullPointerException - if value is nullpublic static JsonElement primitiveNonNull(Character value)+
If the value is null, a NullPointerException will be thrown.
value - the valueNullPointerException - if value is nullpublic static <T> Collector<T,JsonBuilder.JsonObjectBuilder,JsonObject> collectToObject(Function<? super T,String> keyMapper, + Function<? super T,JsonElement> valueMapper)+
T - the typekeyMapper - the function to map from T to StringvalueMapper - the function to map from T to JsonElementpublic static <T> Collector<T,JsonBuilder.JsonArrayBuilder,JsonArray> collectToArray(Function<? super T,JsonElement> valueMapper)+
T - the typevalueMapper - the function to map from T to JsonElementpublic static Collector<JsonElement,JsonBuilder.JsonArrayBuilder,JsonArray> collectToArray()+
public static Collector<GsonSerializable,JsonBuilder.JsonArrayBuilder,JsonArray> collectSerializablesToArray()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonProvider.html b/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonProvider.html new file mode 100644 index 00000000..eef0a8d2 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonProvider.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonSerializable.html b/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonSerializable.html new file mode 100644 index 00000000..6fe628aa --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonSerializable.html @@ -0,0 +1,309 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.gson | ++ |
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
default <T extends GsonSerializable> |
+JsonBuilder.JsonObjectBuilder.addAllSerializables(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends GsonSerializable> |
+JsonBuilder.JsonObjectBuilder.addAllSerializablesIfAbsent(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends GsonSerializable> |
+JsonBuilder.JsonArrayBuilder.addSerializables(Iterable<T> iterable) |
+
static <T extends GsonSerializable> |
+GsonSerializable.deserialize(Class<T> clazz,
+ JsonElement element)
+Deserializes a JsonElement to a GsonSerializable object.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Collector<GsonSerializable,JsonBuilder.JsonArrayBuilder,JsonArray> |
+JsonBuilder.collectSerializablesToArray()
+Returns a collector which forms a JsonArray from GsonSerializables
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(GsonSerializable serializable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ GsonSerializable serializable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ GsonSerializable serializable) |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Hologram
+A simple hologram utility.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BlockPosition
+An immutable and serializable block location object
+ |
+
class |
+BlockRegion
+An immutable and serializable block region object
+ |
+
class |
+ChunkPosition
+An immutable and serializable chuck location object
+ |
+
class |
+ChunkRegion
+An immutable and serializable chunk region object
+ |
+
class |
+Direction
+An immutable and serializable direction object
+ |
+
class |
+Point
+An immutable and serializable position + direction object
+ |
+
class |
+Position
+An immutable and serializable location object
+ |
+
class |
+Region
+An immutable and serializable region object
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonSerializableAdapterFactory.html b/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonSerializableAdapterFactory.html new file mode 100644 index 00000000..2feca57f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/class-use/GsonSerializableAdapterFactory.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.gson | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static GsonSerializableAdapterFactory |
+GsonSerializableAdapterFactory.INSTANCE |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.JsonArrayBuilder.html b/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.JsonArrayBuilder.html new file mode 100644 index 00000000..772abd15 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.JsonArrayBuilder.html @@ -0,0 +1,275 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.gson | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(Boolean value) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(Character value) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(GsonSerializable serializable) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(JsonElement value) |
+
JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(JsonElement value,
+ boolean copy) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(Number value) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.add(String value) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonArrayBuilder.addAll(Iterable<T> iterable) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonArrayBuilder.addAll(Iterable<T> iterable,
+ boolean copy) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonArrayBuilder.addAll(Stream<T> stream) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonArrayBuilder.addAll(Stream<T> stream,
+ boolean copy) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.addBooleans(Iterable<Boolean> iterable) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.addCharacters(Iterable<Character> iterable) |
+
default <T extends Number> |
+JsonBuilder.JsonArrayBuilder.addNumbers(Iterable<T> iterable) |
+
default <T extends GsonSerializable> |
+JsonBuilder.JsonArrayBuilder.addSerializables(Iterable<T> iterable) |
+
default JsonBuilder.JsonArrayBuilder |
+JsonBuilder.JsonArrayBuilder.addStrings(Iterable<String> iterable) |
+
static JsonBuilder.JsonArrayBuilder |
+JsonBuilder.array()
+Creates a new array builder, with no initial values
+ |
+
static JsonBuilder.JsonArrayBuilder |
+JsonBuilder.array(JsonArray array)
+Creates a new array builder, without copying the passed array.
+ |
+
static JsonBuilder.JsonArrayBuilder |
+JsonBuilder.array(JsonArray array,
+ boolean copy)
+Creates a new array builder
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Collector<GsonSerializable,JsonBuilder.JsonArrayBuilder,JsonArray> |
+JsonBuilder.collectSerializablesToArray()
+Returns a collector which forms a JsonArray from GsonSerializables
+ |
+
static Collector<JsonElement,JsonBuilder.JsonArrayBuilder,JsonArray> |
+JsonBuilder.collectToArray()
+Returns a collector which forms a JsonArray from JsonElements
+ |
+
static <T> Collector<T,JsonBuilder.JsonArrayBuilder,JsonArray> |
+JsonBuilder.collectToArray(Function<? super T,JsonElement> valueMapper)
+Returns a collector which forms a JsonArray using the value mapper
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.JsonObjectBuilder.html b/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.JsonObjectBuilder.html new file mode 100644 index 00000000..16729250 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.JsonObjectBuilder.html @@ -0,0 +1,363 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.gson | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ Boolean value) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ Character value) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ GsonSerializable serializable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ JsonElement value) |
+
JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ JsonElement value,
+ boolean copy) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ Number value) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.add(String property,
+ String value) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAll(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAll(Iterable<Map.Entry<String,T>> iterable,
+ boolean deepCopy) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAll(JsonObject object) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAll(JsonObject object,
+ boolean deepCopy) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAll(Stream<Map.Entry<String,T>> stream) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAll(Stream<Map.Entry<String,T>> stream,
+ boolean deepCopy) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllBooleans(Iterable<Map.Entry<String,Boolean>> iterable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllBooleansIfAbsent(Iterable<Map.Entry<String,Boolean>> iterable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllCharacters(Iterable<Map.Entry<String,Character>> iterable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllCharactersIfAbsent(Iterable<Map.Entry<String,Character>> iterable) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAllIfAbsent(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAllIfAbsent(Iterable<Map.Entry<String,T>> iterable,
+ boolean deepCopy) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllIfAbsent(JsonObject object) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllIfAbsent(JsonObject object,
+ boolean deepCopy) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAllIfAbsent(Stream<Map.Entry<String,T>> stream) |
+
default <T extends JsonElement> |
+JsonBuilder.JsonObjectBuilder.addAllIfAbsent(Stream<Map.Entry<String,T>> stream,
+ boolean deepCopy) |
+
default <T extends Number> |
+JsonBuilder.JsonObjectBuilder.addAllNumbers(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends Number> |
+JsonBuilder.JsonObjectBuilder.addAllNumbersIfAbsent(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends GsonSerializable> |
+JsonBuilder.JsonObjectBuilder.addAllSerializables(Iterable<Map.Entry<String,T>> iterable) |
+
default <T extends GsonSerializable> |
+JsonBuilder.JsonObjectBuilder.addAllSerializablesIfAbsent(Iterable<Map.Entry<String,T>> iterable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllStrings(Iterable<Map.Entry<String,String>> iterable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addAllStringsIfAbsent(Iterable<Map.Entry<String,String>> iterable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ Boolean value) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ Character value) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ GsonSerializable serializable) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ JsonElement value) |
+
JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ JsonElement value,
+ boolean copy) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ Number value) |
+
default JsonBuilder.JsonObjectBuilder |
+JsonBuilder.JsonObjectBuilder.addIfAbsent(String property,
+ String value) |
+
static JsonBuilder.JsonObjectBuilder |
+JsonBuilder.object()
+Creates a new object builder, with no initial values
+ |
+
static JsonBuilder.JsonObjectBuilder |
+JsonBuilder.object(JsonObject object)
+Creates a new object builder, without copying the passed object.
+ |
+
static JsonBuilder.JsonObjectBuilder |
+JsonBuilder.object(JsonObject object,
+ boolean copy)
+Creates a new object builder
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static <T> Collector<T,JsonBuilder.JsonObjectBuilder,JsonObject> |
+JsonBuilder.collectToObject(Function<? super T,String> keyMapper,
+ Function<? super T,JsonElement> valueMapper)
+Returns a collector which forms a JsonObject using the key and value mappers
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.html b/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.html new file mode 100644 index 00000000..853e6bf3 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/class-use/JsonBuilder.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/package-frame.html b/docs/javadoc/helper/me/lucko/helper/gson/package-frame.html new file mode 100644 index 00000000..f5808369 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/package-frame.html @@ -0,0 +1,29 @@ + + + + + + +| Interface | +Description | +
|---|---|
| GsonSerializable | +
+ An object which can be serialized to JSON.
+ |
+
| JsonBuilder.JsonArrayBuilder | +
+ A
+JsonArray builder utility |
+
| JsonBuilder.JsonObjectBuilder | +
+ A
+JsonObject builder utility |
+
| Class | +Description | +
|---|---|
| GsonProvider | +
+ Provides static instances of Gson
+ |
+
| GsonSerializableAdapterFactory | ++ |
| JsonBuilder | +
+ Builder utilities for creating GSON Objects/Arrays.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/package-tree.html b/docs/javadoc/helper/me/lucko/helper/gson/package-tree.html new file mode 100644 index 00000000..bd3d016b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/gson/package-use.html b/docs/javadoc/helper/me/lucko/helper/gson/package-use.html new file mode 100644 index 00000000..0d5eb4d7 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/gson/package-use.html @@ -0,0 +1,216 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.gson | ++ |
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.serialize | ++ |
| Class and Description | +
|---|
| GsonSerializable
+ An object which can be serialized to JSON.
+ |
+
| GsonSerializableAdapterFactory | +
| JsonBuilder.JsonArrayBuilder
+ A
+JsonArray builder utility |
+
| JsonBuilder.JsonObjectBuilder
+ A
+JsonObject builder utility |
+
| Class and Description | +
|---|
| GsonSerializable
+ An object which can be serialized to JSON.
+ |
+
| Class and Description | +
|---|
| GsonSerializable
+ An object which can be serialized to JSON.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/hologram/Hologram.html b/docs/javadoc/helper/me/lucko/helper/hologram/Hologram.html new file mode 100644 index 00000000..cf286d81 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/hologram/Hologram.html @@ -0,0 +1,388 @@ + + + + + + +public interface Hologram +extends Terminable, GsonSerializable+
EMPTY| Modifier and Type | +Method and Description | +
|---|---|
static Hologram |
+create(Position position,
+ List<String> lines)
+Creates and returns a new hologram
+ |
+
static Hologram |
+deserialize(JsonElement element) |
+
void |
+despawn()
+Despawns the hologram
+ |
+
void |
+setClickCallback(Consumer<Player> clickCallback)
+Sets a click callback for this hologram
+ |
+
void |
+spawn()
+Spawns the hologram
+ |
+
void |
+updateLines(List<String> lines)
+Updates the lines displayed by this hologram
+ |
+
void |
+updatePosition(Position position)
+Updates the position of the hologram and respawns it
+ |
+
bindWith, hasTerminated, of, terminatedeserialize, getDeserializeMethod, serialize@Nonnull +static Hologram create(@Nonnull + Position position, + @Nonnull + List<String> lines)+
Note: the hologram will not be spawned automatically.
position - the position of the hologramlines - the initial lines to displaystatic Hologram deserialize(JsonElement element)+
void spawn()+
void despawn()+
void updatePosition(@Nonnull + Position position)+
position - the new positionvoid updateLines(@Nonnull + List<String> lines)+
This method does not refresh the actual hologram display. spawn() must be called for these changes
+ to apply.
lines - the new linesCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/hologram/class-use/Hologram.html b/docs/javadoc/helper/me/lucko/helper/hologram/class-use/Hologram.html new file mode 100644 index 00000000..84191cce --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/hologram/class-use/Hologram.html @@ -0,0 +1,173 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.hologram | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Hologram |
+Hologram.create(Position position,
+ List<String> lines)
+Creates and returns a new hologram
+ |
+
static Hologram |
+Hologram.deserialize(JsonElement element) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/hologram/package-frame.html b/docs/javadoc/helper/me/lucko/helper/hologram/package-frame.html new file mode 100644 index 00000000..1155e8b6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/hologram/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Hologram | +
+ A simple hologram utility.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/hologram/package-tree.html b/docs/javadoc/helper/me/lucko/helper/hologram/package-tree.html new file mode 100644 index 00000000..bb9dcc13 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/hologram/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/hologram/package-use.html b/docs/javadoc/helper/me/lucko/helper/hologram/package-use.html new file mode 100644 index 00000000..ed669357 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/hologram/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.hologram | ++ |
| Class and Description | +
|---|
| Hologram
+ A simple hologram utility.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/Delegate.html b/docs/javadoc/helper/me/lucko/helper/interfaces/Delegate.html new file mode 100644 index 00000000..15e2ea6e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/Delegate.html @@ -0,0 +1,248 @@ + + + + + + +T - the delegate typepublic interface Delegate<T>
+| Modifier and Type | +Method and Description | +
|---|---|
T |
+getDelegate()
+Gets the delegate object
+ |
+
static Object |
+resolve(Object obj) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/TypeAware.html b/docs/javadoc/helper/me/lucko/helper/interfaces/TypeAware.html new file mode 100644 index 00000000..8f9986e0 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/TypeAware.html @@ -0,0 +1,233 @@ + + + + + + +T - the typepublic interface TypeAware<T>
+| Modifier and Type | +Method and Description | +
|---|---|
TypeToken<T> |
+getType() |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/class-use/Delegate.html b/docs/javadoc/helper/me/lucko/helper/interfaces/class-use/Delegate.html new file mode 100644 index 00000000..06014cd8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/class-use/Delegate.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/class-use/TypeAware.html b/docs/javadoc/helper/me/lucko/helper/interfaces/class-use/TypeAware.html new file mode 100644 index 00000000..d47011d2 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/class-use/TypeAware.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Channel<T>
+Represents an individual messaging channel.
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+MetadataKey<T>
+A MetadataKey can be mapped to values in a
+MetadataMap. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/package-frame.html b/docs/javadoc/helper/me/lucko/helper/interfaces/package-frame.html new file mode 100644 index 00000000..16d218f7 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/package-tree.html b/docs/javadoc/helper/me/lucko/helper/interfaces/package-tree.html new file mode 100644 index 00000000..b2df1437 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/package-tree.html @@ -0,0 +1,136 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/interfaces/package-use.html b/docs/javadoc/helper/me/lucko/helper/interfaces/package-use.html new file mode 100644 index 00000000..d5734042 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/interfaces/package-use.html @@ -0,0 +1,182 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.metadata | ++ |
| Class and Description | +
|---|
| TypeAware
+ Represents an object that knows it's own type parameter.
+ |
+
| Class and Description | +
|---|
| TypeAware
+ Represents an object that knows it's own type parameter.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/item/ItemStackBuilder.html b/docs/javadoc/helper/me/lucko/helper/item/ItemStackBuilder.html new file mode 100644 index 00000000..84ab62a2 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/item/ItemStackBuilder.html @@ -0,0 +1,675 @@ + + + + + + +@NonnullByDefault +public final class ItemStackBuilder +extends Object+
ItemStack instancespublic static ItemStackBuilder of(Material material)+
public static ItemStackBuilder of(ItemStack itemStack)+
public ItemStackBuilder transform(Consumer<ItemStack> is)+
public ItemStackBuilder transformMeta(Consumer<ItemMeta> meta)+
public ItemStackBuilder name(String name)+
public ItemStackBuilder type(Material material)+
public ItemStackBuilder lore(String line)+
public ItemStackBuilder lore(String... lines)+
public ItemStackBuilder lore(Iterable<String> lines)+
public ItemStackBuilder clearLore()+
public ItemStackBuilder durability(int durability)+
public ItemStackBuilder data(int data)+
public ItemStackBuilder amount(int amount)+
public ItemStackBuilder enchant(Enchantment enchantment, + int level)+
public ItemStackBuilder enchant(Enchantment enchantment)+
public ItemStackBuilder clearEnchantments()+
public ItemStackBuilder flag(ItemFlag... flags)+
public ItemStackBuilder unflag(ItemFlag... flags)+
public ItemStackBuilder hideAttributes()+
public ItemStackBuilder showAttributes()+
public ItemStackBuilder color(Color color)+
public ItemStackBuilder breakable(boolean flag)+
public ItemStackBuilder apply(Consumer<ItemStackBuilder> consumer)+
public ItemStack build()+
public Item.Builder buildItem()+
public Item buildConsumer(@Nullable + Consumer<InventoryClickEvent> handler)+
public Item buildConsumer(ClickType type, + @Nullable + Consumer<InventoryClickEvent> handler)+
public Item buildConsumer(@Nullable + Consumer<InventoryClickEvent> rightClick, + @Nullable + Consumer<InventoryClickEvent> leftClick)+
public Item buildFromConsumerMap(Map<ClickType,Consumer<InventoryClickEvent>> handlers)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/item/class-use/ItemStackBuilder.html b/docs/javadoc/helper/me/lucko/helper/item/class-use/ItemStackBuilder.html new file mode 100644 index 00000000..dff59842 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/item/class-use/ItemStackBuilder.html @@ -0,0 +1,268 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.item | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ItemStackBuilder |
+ItemStackBuilder.amount(int amount) |
+
ItemStackBuilder |
+ItemStackBuilder.apply(Consumer<ItemStackBuilder> consumer) |
+
ItemStackBuilder |
+ItemStackBuilder.breakable(boolean flag) |
+
ItemStackBuilder |
+ItemStackBuilder.clearEnchantments() |
+
ItemStackBuilder |
+ItemStackBuilder.clearLore() |
+
ItemStackBuilder |
+ItemStackBuilder.color(Color color) |
+
ItemStackBuilder |
+ItemStackBuilder.data(int data) |
+
ItemStackBuilder |
+ItemStackBuilder.durability(int durability) |
+
ItemStackBuilder |
+ItemStackBuilder.enchant(Enchantment enchantment) |
+
ItemStackBuilder |
+ItemStackBuilder.enchant(Enchantment enchantment,
+ int level) |
+
ItemStackBuilder |
+ItemStackBuilder.flag(ItemFlag... flags) |
+
ItemStackBuilder |
+ItemStackBuilder.hideAttributes() |
+
ItemStackBuilder |
+ItemStackBuilder.lore(Iterable<String> lines) |
+
ItemStackBuilder |
+ItemStackBuilder.lore(String... lines) |
+
ItemStackBuilder |
+ItemStackBuilder.lore(String line) |
+
ItemStackBuilder |
+ItemStackBuilder.name(String name) |
+
static ItemStackBuilder |
+ItemStackBuilder.of(ItemStack itemStack) |
+
static ItemStackBuilder |
+ItemStackBuilder.of(Material material) |
+
ItemStackBuilder |
+ItemStackBuilder.showAttributes() |
+
ItemStackBuilder |
+ItemStackBuilder.transform(Consumer<ItemStack> is) |
+
ItemStackBuilder |
+ItemStackBuilder.transformMeta(Consumer<ItemMeta> meta) |
+
ItemStackBuilder |
+ItemStackBuilder.type(Material material) |
+
ItemStackBuilder |
+ItemStackBuilder.unflag(ItemFlag... flags) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ItemStackBuilder |
+ItemStackBuilder.apply(Consumer<ItemStackBuilder> consumer) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/item/package-frame.html b/docs/javadoc/helper/me/lucko/helper/item/package-frame.html new file mode 100644 index 00000000..c4c0d8b4 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/item/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| ItemStackBuilder | +
+ Easily construct
+ItemStack instances |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/item/package-tree.html b/docs/javadoc/helper/me/lucko/helper/item/package-tree.html new file mode 100644 index 00000000..184c3b89 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/item/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/item/package-use.html b/docs/javadoc/helper/me/lucko/helper/item/package-use.html new file mode 100644 index 00000000..d1366c20 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/item/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.item | ++ |
| Class and Description | +
|---|
| ItemStackBuilder
+ Easily construct
+ItemStack instances |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/LibraryLoader.Dependency.html b/docs/javadoc/helper/me/lucko/helper/maven/LibraryLoader.Dependency.html new file mode 100644 index 00000000..312c80b8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/LibraryLoader.Dependency.html @@ -0,0 +1,392 @@ + + + + + + +@NonnullByDefault +public static final class LibraryLoader.Dependency +extends Object+
| Constructor and Description | +
|---|
Dependency(String groupId,
+ String artifactId,
+ String version,
+ String repoUrl) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
String |
+getArtifactId() |
+
String |
+getGroupId() |
+
String |
+getRepoUrl() |
+
URL |
+getUrl() |
+
String |
+getVersion() |
+
int |
+hashCode() |
+
String |
+toString() |
+
public String getGroupId()+
public String getArtifactId()+
public String getVersion()+
public String getRepoUrl()+
public URL getUrl() + throws MalformedURLException+
MalformedURLExceptionCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/LibraryLoader.html b/docs/javadoc/helper/me/lucko/helper/maven/LibraryLoader.html new file mode 100644 index 00000000..26a60a69 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/LibraryLoader.html @@ -0,0 +1,371 @@ + + + + + + +@NonnullByDefault +public final class LibraryLoader +extends Object+
MavenLibrary annotations for a class, and loads the dependency
+ into the classloader.| Modifier and Type | +Class and Description | +
|---|---|
static class |
+LibraryLoader.Dependency |
+
| Constructor and Description | +
|---|
LibraryLoader() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+load(LibraryLoader.Dependency d) |
+
static void |
+load(String groupId,
+ String artifactId,
+ String version) |
+
static void |
+load(String groupId,
+ String artifactId,
+ String version,
+ String repoUrl) |
+
static void |
+loadAll(Class<?> clazz)
+Resolves all
+MavenLibrary annotations on the given class. |
+
static void |
+loadAll(Object object)
+Resolves all
+MavenLibrary annotations on the given object. |
+
public static void loadAll(Object object)+
MavenLibrary annotations on the given object.object - the object to load libraries for.public static void loadAll(Class<?> clazz)+
MavenLibrary annotations on the given class.clazz - the class to load libraries for.public static void load(String groupId, + String artifactId, + String version, + String repoUrl)+
public static void load(LibraryLoader.Dependency d)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/MavenLibraries.html b/docs/javadoc/helper/me/lucko/helper/maven/MavenLibraries.html new file mode 100644 index 00000000..508e52f4 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/MavenLibraries.html @@ -0,0 +1,222 @@ + + + + + + +@Documented + @Target(value=TYPE) + @Retention(value=RUNTIME) +public @interface MavenLibraries+
| Modifier and Type | +Optional Element and Description | +
|---|---|
MavenLibrary[] |
+value |
+
@Nonnull +public abstract MavenLibrary[] value+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/MavenLibrary.html b/docs/javadoc/helper/me/lucko/helper/maven/MavenLibrary.html new file mode 100644 index 00000000..c772456a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/MavenLibrary.html @@ -0,0 +1,318 @@ + + + + + + +@Documented + @Repeatable(value=MavenLibraries.class) + @Target(value=TYPE) + @Retention(value=RUNTIME) +public @interface MavenLibrary+
| Modifier and Type | +Required Element and Description | +
|---|---|
String |
+artifactId
+The artifact id of the library
+ |
+
String |
+groupId
+The group id of the library
+ |
+
String |
+version
+The version of the library
+ |
+
| Modifier and Type | +Optional Element and Description | +
|---|---|
Repository |
+repo
+The repo where the library can be obtained from
+ |
+
@Nonnull +public abstract Repository repo+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/Repository.html b/docs/javadoc/helper/me/lucko/helper/maven/Repository.html new file mode 100644 index 00000000..89031527 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/Repository.html @@ -0,0 +1,225 @@ + + + + + + +@Documented + @Target(value=LOCAL_VARIABLE) + @Retention(value=RUNTIME) +public @interface Repository+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/class-use/LibraryLoader.Dependency.html b/docs/javadoc/helper/me/lucko/helper/maven/class-use/LibraryLoader.Dependency.html new file mode 100644 index 00000000..0377c4ff --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/class-use/LibraryLoader.Dependency.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.maven | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+LibraryLoader.load(LibraryLoader.Dependency d) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/class-use/LibraryLoader.html b/docs/javadoc/helper/me/lucko/helper/maven/class-use/LibraryLoader.html new file mode 100644 index 00000000..06de192f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/class-use/LibraryLoader.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/class-use/MavenLibraries.html b/docs/javadoc/helper/me/lucko/helper/maven/class-use/MavenLibraries.html new file mode 100644 index 00000000..4fdafb9d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/class-use/MavenLibraries.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/class-use/MavenLibrary.html b/docs/javadoc/helper/me/lucko/helper/maven/class-use/MavenLibrary.html new file mode 100644 index 00000000..1ff2a52b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/class-use/MavenLibrary.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/class-use/Repository.html b/docs/javadoc/helper/me/lucko/helper/maven/class-use/Repository.html new file mode 100644 index 00000000..158b5d0b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/class-use/Repository.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/package-frame.html b/docs/javadoc/helper/me/lucko/helper/maven/package-frame.html new file mode 100644 index 00000000..222e5330 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +| Class | +Description | +
|---|---|
| LibraryLoader | +
+ Resolves
+MavenLibrary annotations for a class, and loads the dependency
+ into the classloader. |
+
| LibraryLoader.Dependency | ++ |
| Annotation Type | +Description | +
|---|---|
| MavenLibraries | +
+ Annotation to indicate the required libraries for a class.
+ |
+
| MavenLibrary | +
+ Annotation to indicate a required library for a class.
+ |
+
| Repository | +
+ Represents a maven repository.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/package-tree.html b/docs/javadoc/helper/me/lucko/helper/maven/package-tree.html new file mode 100644 index 00000000..d1c67cb8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/package-tree.html @@ -0,0 +1,146 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/maven/package-use.html b/docs/javadoc/helper/me/lucko/helper/maven/package-use.html new file mode 100644 index 00000000..dc3efeb5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/maven/package-use.html @@ -0,0 +1,159 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.maven | ++ |
| Class and Description | +
|---|
| LibraryLoader.Dependency | +
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/Gui.html b/docs/javadoc/helper/me/lucko/helper/menu/Gui.html new file mode 100644 index 00000000..8b5e8275 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/Gui.html @@ -0,0 +1,734 @@ + + + + + + +@NonnullByDefault +public abstract class Gui +extends Object +implements TerminableConsumer+
| Modifier and Type | +Field and Description | +
|---|---|
static MetadataKey<Gui> |
+OPEN_GUI_KEY |
+
| Constructor and Description | +
|---|
Gui(Player player,
+ int lines,
+ String title) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addItem(Item item) |
+
void |
+addItems(Iterable<Item> items) |
+
<T extends Terminable> |
+bind(T terminable)
+Binds with the given terminable.
+ |
+
<T extends Runnable> |
+bindRunnable(T runnable)
+Binds with the given runnable.
+ |
+
void |
+clearItems() |
+
void |
+close() |
+
void |
+fillWith(Item item) |
+
Function<Player,Gui> |
+getFallbackGui() |
+
int |
+getFirstEmpty() |
+
Optional<Slot> |
+getFirstEmptySlot() |
+
Inventory |
+getHandle()
+Gets the delegate Bukkit inventory
+ |
+
String |
+getInitialTitle()
+Gets the initial title which was set when this GUI was made
+ |
+
static int |
+getMenuSize(int count)
+Utility method to get the number of lines needed for x items
+ |
+
Player |
+getPlayer()
+Gets the player viewing this Gui
+ |
+
Slot |
+getSlot(int slot) |
+
boolean |
+isFirstDraw() |
+
boolean |
+isValid()
+Returns true unless this GUI has been invalidated, through being closed, or the player leaving.
+ |
+
void |
+open() |
+
abstract void |
+redraw()
+Places items on the GUI.
+ |
+
void |
+removeItem(int slot) |
+
void |
+removeItems(int... slots) |
+
void |
+removeItems(Iterable<Integer> slots) |
+
void |
+setFallbackGui(Function<Player,Gui> fallbackGui) |
+
void |
+setItem(int slot,
+ Item item) |
+
void |
+setItems(Item item,
+ int... slots) |
+
void |
+setItems(Iterable<Integer> slots,
+ Item item) |
+
public static final MetadataKey<Gui> OPEN_GUI_KEY+
public static int getMenuSize(int count)+
count - the number of itemspublic abstract void redraw()+
isFirstDraw() to determine if this is the first time redraw has been called.public Player getPlayer()+
public Inventory getHandle()+
public String getInitialTitle()+
@Nonnull +public <T extends Terminable> T bind(@Nonnull + T terminable)+
TerminableConsumerbind in interface TerminableConsumerT - the terminable typeterminable - the terminable to bind with@Nonnull +public <T extends Runnable> T bindRunnable(@Nonnull + T runnable)+
TerminableConsumerbindRunnable in interface TerminableConsumerT - the terminable typerunnable - the runnable to bind withpublic boolean isFirstDraw()+
public Slot getSlot(int slot)+
public void setItem(int slot, + Item item)+
public void setItems(Item item, + int... slots)+
public int getFirstEmpty()+
public void addItem(Item item)+
public void fillWith(Item item)+
public void removeItem(int slot)+
public void removeItems(int... slots)+
public void clearItems()+
public void open()+
public void close()+
public boolean isValid()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/Item.Builder.html b/docs/javadoc/helper/me/lucko/helper/menu/Item.Builder.html new file mode 100644 index 00000000..82342eed --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/Item.Builder.html @@ -0,0 +1,347 @@ + + + + + + +| Modifier and Type | +Method and Description | +
|---|---|
Item.Builder |
+bind(ClickType type,
+ Consumer<InventoryClickEvent> handler) |
+
Item.Builder |
+bind(ClickType type,
+ Runnable handler) |
+
Item.Builder |
+bind(Consumer<InventoryClickEvent> handler,
+ ClickType... types) |
+
Item.Builder |
+bind(Runnable handler,
+ ClickType... types) |
+
<T extends Consumer<InventoryClickEvent>> |
+bindAllConsumers(Iterable<Map.Entry<ClickType,T>> handlers) |
+
<T extends Runnable> |
+bindAllRunnables(Iterable<Map.Entry<ClickType,T>> handlers) |
+
Item |
+build() |
+
@Nonnull +public Item.Builder bind(@Nonnull + ClickType type, + @Nullable + Consumer<InventoryClickEvent> handler)+
@Nonnull +public Item.Builder bind(@Nonnull + ClickType type, + @Nullable + Runnable handler)+
@Nonnull +public Item.Builder bind(@Nullable + Consumer<InventoryClickEvent> handler, + @Nonnull + ClickType... types)+
@Nonnull +public Item.Builder bind(@Nullable + Runnable handler, + @Nonnull + ClickType... types)+
@Nonnull +public <T extends Runnable> Item.Builder bindAllRunnables(@Nonnull + Iterable<Map.Entry<ClickType,T>> handlers)+
@Nonnull +public <T extends Consumer<InventoryClickEvent>> Item.Builder bindAllConsumers(@Nonnull + Iterable<Map.Entry<ClickType,T>> handlers)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/Item.html b/docs/javadoc/helper/me/lucko/helper/menu/Item.html new file mode 100644 index 00000000..dafac371 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/Item.html @@ -0,0 +1,358 @@ + + + + + + +| Modifier and Type | +Class and Description | +
|---|---|
static class |
+Item.Builder
+Aids creation of
+Item instances. |
+
| Constructor and Description | +
|---|
Item(Map<ClickType,Consumer<InventoryClickEvent>> handlers,
+ ItemStack itemStack) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Item.Builder |
+builder(ItemStack itemStack) |
+
Map<ClickType,Consumer<InventoryClickEvent>> |
+getHandlers()
+Gets the click handlers for this Item.
+ |
+
ItemStack |
+getItemStack()
+Gets the ItemStack backing this Item.
+ |
+
static Consumer<InventoryClickEvent> |
+transformRunnable(Runnable runnable) |
+
@Nonnull +public static Item.Builder builder(@Nonnull + ItemStack itemStack)+
@Nonnull +public Map<ClickType,Consumer<InventoryClickEvent>> getHandlers()+
@Nonnull +public ItemStack getItemStack()+
@Nonnull +public static Consumer<InventoryClickEvent> transformRunnable(@Nonnull + Runnable runnable)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/Slot.html b/docs/javadoc/helper/me/lucko/helper/menu/Slot.html new file mode 100644 index 00000000..4dd8c9d6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/Slot.html @@ -0,0 +1,629 @@ + + + + + + +| Modifier and Type | +Field and Description | +
|---|---|
protected Map<ClickType,Set<Consumer<InventoryClickEvent>>> |
+handlers |
+
| Constructor and Description | +
|---|
Slot(Gui gui,
+ int id) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Slot |
+applyFromItem(Item item)
+Applies an item model to this slot.
+ |
+
Slot |
+bind(ClickType type,
+ Consumer<InventoryClickEvent> handler) |
+
Slot |
+bind(ClickType type,
+ Runnable handler) |
+
Slot |
+bind(Consumer<InventoryClickEvent> handler,
+ ClickType... types) |
+
Slot |
+bind(Runnable handler,
+ ClickType... types) |
+
<T extends Consumer<InventoryClickEvent>> |
+bindAllConsumers(Iterable<Map.Entry<ClickType,T>> handlers) |
+
<T extends Runnable> |
+bindAllRunnables(Iterable<Map.Entry<ClickType,T>> handlers) |
+
Slot |
+clear()
+Clears all attributes of the slot.
+ |
+
Slot |
+clearBindings()
+Clears all bindings on this slot.
+ |
+
Slot |
+clearBindings(ClickType type)
+Clears all bindings on this slot for a given click type.
+ |
+
Slot |
+clearItem()
+Clears the item in this slot
+ |
+
int |
+getId()
+Gets the id of this slot
+ |
+
ItemStack |
+getItem()
+Gets the item in this slot
+ |
+
Gui |
+gui()
+Gets the GUI this slot references
+ |
+
void |
+handle(InventoryClickEvent event) |
+
boolean |
+hasItem()
+Gets if this slot has an item
+ |
+
Slot |
+setItem(ItemStack item)
+Sets the item in this slot
+ |
+
protected final Map<ClickType,Set<Consumer<InventoryClickEvent>>> handlers+
@Nonnull +public Gui gui()+
public int getId()+
public Slot applyFromItem(Item item)+
item - the item@Nullable +public ItemStack getItem()+
public boolean hasItem()+
@Nonnull +public Slot setItem(@Nonnull + ItemStack item)+
item - the new itempublic Slot clear()+
@Nonnull +public Slot clearItem()+
@Nonnull +public Slot clearBindings()+
@Nonnull +public Slot clearBindings(ClickType type)+
public void handle(@Nonnull + InventoryClickEvent event)+
@Nonnull +public Slot bind(@Nonnull + ClickType type, + @Nonnull + Consumer<InventoryClickEvent> handler)+
@Nonnull +public Slot bind(@Nonnull + Consumer<InventoryClickEvent> handler, + @Nonnull + ClickType... types)+
@Nonnull +public Slot bind(@Nonnull + Runnable handler, + @Nonnull + ClickType... types)+
@Nonnull +public <T extends Runnable> Slot bindAllRunnables(@Nonnull + Iterable<Map.Entry<ClickType,T>> handlers)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/class-use/Gui.html b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Gui.html new file mode 100644 index 00000000..cd6f60ab --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Gui.html @@ -0,0 +1,285 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static MetadataKey<Gui> |
+Gui.OPEN_GUI_KEY |
+
| Modifier and Type | +Method and Description | +
|---|---|
Gui |
+Slot.gui()
+Gets the GUI this slot references
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Function<Player,Gui> |
+Gui.getFallbackGui() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Gui.setFallbackGui(Function<Player,Gui> fallbackGui) |
+
| Constructor and Description | +
|---|
Slot(Gui gui,
+ int id) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PaginatedGui
+
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MenuScheme.apply(Gui gui) |
+
MenuPopulator |
+MenuScheme.newPopulator(Gui gui) |
+
| Constructor and Description | +
|---|
MenuPopulator(Gui gui,
+ List<Integer> slots) |
+
MenuPopulator(Gui gui,
+ MenuScheme scheme) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/class-use/Item.Builder.html b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Item.Builder.html new file mode 100644 index 00000000..1f3ac887 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Item.Builder.html @@ -0,0 +1,216 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.item | ++ |
| me.lucko.helper.menu | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Item.Builder |
+ItemStackBuilder.buildItem() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Item.Builder |
+Item.Builder.bind(ClickType type,
+ Consumer<InventoryClickEvent> handler) |
+
Item.Builder |
+Item.Builder.bind(ClickType type,
+ Runnable handler) |
+
Item.Builder |
+Item.Builder.bind(Consumer<InventoryClickEvent> handler,
+ ClickType... types) |
+
Item.Builder |
+Item.Builder.bind(Runnable handler,
+ ClickType... types) |
+
<T extends Consumer<InventoryClickEvent>> |
+Item.Builder.bindAllConsumers(Iterable<Map.Entry<ClickType,T>> handlers) |
+
<T extends Runnable> |
+Item.Builder.bindAllRunnables(Iterable<Map.Entry<ClickType,T>> handlers) |
+
static Item.Builder |
+Item.builder(ItemStack itemStack) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/class-use/Item.html b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Item.html new file mode 100644 index 00000000..02bdaaec --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Item.html @@ -0,0 +1,394 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.item | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Item |
+ItemStackBuilder.build(ClickType type,
+ Runnable handler) |
+
Item |
+ItemStackBuilder.build(Runnable handler) |
+
Item |
+ItemStackBuilder.build(Runnable rightClick,
+ Runnable leftClick) |
+
Item |
+ItemStackBuilder.buildConsumer(ClickType type,
+ Consumer<InventoryClickEvent> handler) |
+
Item |
+ItemStackBuilder.buildConsumer(Consumer<InventoryClickEvent> handler) |
+
Item |
+ItemStackBuilder.buildConsumer(Consumer<InventoryClickEvent> rightClick,
+ Consumer<InventoryClickEvent> leftClick) |
+
Item |
+ItemStackBuilder.buildFromConsumerMap(Map<ClickType,Consumer<InventoryClickEvent>> handlers) |
+
Item |
+ItemStackBuilder.buildFromMap(Map<ClickType,Runnable> handlers) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Item |
+Item.Builder.build() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Gui.addItem(Item item) |
+
Slot |
+Slot.applyFromItem(Item item)
+Applies an item model to this slot.
+ |
+
void |
+Gui.fillWith(Item item) |
+
void |
+Gui.setItem(int slot,
+ Item item) |
+
void |
+Gui.setItems(Item item,
+ int... slots) |
+
void |
+Gui.setItems(Iterable<Integer> slots,
+ Item item) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Gui.addItems(Iterable<Item> items) |
+
| Modifier and Type | +Method and Description | +
|---|---|
PaginatedGui |
+PaginatedGuiBuilder.build(Player player,
+ Function<PaginatedGui,List<Item>> content) |
+
void |
+PaginatedGui.updateContent(List<Item> content) |
+
| Constructor and Description | +
|---|
PaginatedGui(Function<PaginatedGui,List<Item>> content,
+ Player player,
+ PaginatedGuiBuilder model) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Item |
+SchemeMapping.getNullable(int key)
+Gets an item from the mapping which represents the given key.
+ |
+
Item |
+AbstractSchemeMapping.getNullable(int key) |
+
| Modifier and Type | +Method and Description | +
|---|---|
default Optional<Item> |
+SchemeMapping.get(int key)
+Gets an item from the mapping which represents the given key.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
MenuPopulator |
+MenuPopulator.accept(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
MenuPopulator |
+MenuPopulator.acceptIfSpace(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
boolean |
+MenuPopulator.placeIfSpace(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
| Modifier and Type | +Method and Description | +
|---|---|
static SchemeMapping |
+AbstractSchemeMapping.of(Map<Integer,Item> mapping) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/class-use/Slot.html b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Slot.html new file mode 100644 index 00000000..20b08a95 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/class-use/Slot.html @@ -0,0 +1,273 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.scheme | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Slot |
+Slot.applyFromItem(Item item)
+Applies an item model to this slot.
+ |
+
Slot |
+Slot.bind(ClickType type,
+ Consumer<InventoryClickEvent> handler) |
+
Slot |
+Slot.bind(ClickType type,
+ Runnable handler) |
+
Slot |
+Slot.bind(Consumer<InventoryClickEvent> handler,
+ ClickType... types) |
+
Slot |
+Slot.bind(Runnable handler,
+ ClickType... types) |
+
<T extends Consumer<InventoryClickEvent>> |
+Slot.bindAllConsumers(Iterable<Map.Entry<ClickType,T>> handlers) |
+
<T extends Runnable> |
+Slot.bindAllRunnables(Iterable<Map.Entry<ClickType,T>> handlers) |
+
Slot |
+Slot.clear()
+Clears all attributes of the slot.
+ |
+
Slot |
+Slot.clearBindings()
+Clears all bindings on this slot.
+ |
+
Slot |
+Slot.clearBindings(ClickType type)
+Clears all bindings on this slot for a given click type.
+ |
+
Slot |
+Slot.clearItem()
+Clears the item in this slot
+ |
+
Slot |
+Gui.getSlot(int slot) |
+
Slot |
+Slot.setItem(ItemStack item)
+Sets the item in this slot
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Optional<Slot> |
+Gui.getFirstEmptySlot() |
+
| Modifier and Type | +Method and Description | +
|---|---|
MenuPopulator |
+MenuPopulator.consume(Consumer<Slot> action) |
+
MenuPopulator |
+MenuPopulator.consumeIfSpace(Consumer<Slot> action) |
+
boolean |
+MenuPopulator.tryConsume(Consumer<Slot> action) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/package-frame.html b/docs/javadoc/helper/me/lucko/helper/menu/package-frame.html new file mode 100644 index 00000000..8e306ad7 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/package-frame.html @@ -0,0 +1,24 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/package-tree.html b/docs/javadoc/helper/me/lucko/helper/menu/package-tree.html new file mode 100644 index 00000000..e2e32585 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/package-tree.html @@ -0,0 +1,142 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/package-use.html b/docs/javadoc/helper/me/lucko/helper/menu/package-use.html new file mode 100644 index 00000000..ec58c77d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/package-use.html @@ -0,0 +1,259 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.item | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| Class and Description | +
|---|
| Item
+ The initial model of a clickable item in a
+Gui. |
+
| Item.Builder
+ Aids creation of
+Item instances. |
+
| Class and Description | +
|---|
| Gui
+ A simple GUI abstraction
+ |
+
| Item
+ The initial model of a clickable item in a
+Gui. |
+
| Item.Builder
+ Aids creation of
+Item instances. |
+
| Slot
+ Represents a slot in a
+Gui. |
+
| Class and Description | +
|---|
| Gui
+ A simple GUI abstraction
+ |
+
| Item
+ The initial model of a clickable item in a
+Gui. |
+
| Class and Description | +
|---|
| Gui
+ A simple GUI abstraction
+ |
+
| Item
+ The initial model of a clickable item in a
+Gui. |
+
| Slot
+ Represents a slot in a
+Gui. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/PageInfo.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/PageInfo.html new file mode 100644 index 00000000..7dde9800 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/PageInfo.html @@ -0,0 +1,269 @@ + + + + + + +public final class PageInfo +extends Object+
PaginatedGui.| Modifier and Type | +Method and Description | +
|---|---|
static PageInfo |
+create(int current,
+ int size) |
+
int |
+getCurrent() |
+
int |
+getSize() |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/PaginatedGui.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/PaginatedGui.html new file mode 100644 index 00000000..1546a0f9 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/PaginatedGui.html @@ -0,0 +1,332 @@ + + + + + + +@NonnullByDefault +public class PaginatedGui +extends Gui+ +
OPEN_GUI_KEY| Constructor and Description | +
|---|
PaginatedGui(Function<PaginatedGui,List<Item>> content,
+ Player player,
+ PaginatedGuiBuilder model) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+redraw()
+Places items on the GUI.
+ |
+
void |
+updateContent(List<Item> content) |
+
addItem, addItems, bind, bindRunnable, clearItems, close, fillWith, getFallbackGui, getFirstEmpty, getFirstEmptySlot, getHandle, getInitialTitle, getMenuSize, getPlayer, getSlot, isFirstDraw, isValid, open, removeItem, removeItems, removeItems, setFallbackGui, setItem, setItems, setItemspublic PaginatedGui(Function<PaginatedGui,List<Item>> content, + Player player, + PaginatedGuiBuilder model)+
public void redraw()+
GuiGui.isFirstDraw() to determine if this is the first time redraw has been called.Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/PaginatedGuiBuilder.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/PaginatedGuiBuilder.html new file mode 100644 index 00000000..6a74f24c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/PaginatedGuiBuilder.html @@ -0,0 +1,595 @@ + + + + + + +@NonnullByDefault +public class PaginatedGuiBuilder +extends Object+
PaginatedGui.| Modifier and Type | +Field and Description | +
|---|---|
static List<Integer> |
+DEFAULT_ITEM_SLOTS |
+
static int |
+DEFAULT_LINES |
+
static Function<PageInfo,ItemStack> |
+DEFAULT_NEXT_PAGE_ITEM |
+
static int |
+DEFAULT_NEXT_PAGE_SLOT |
+
static Function<PageInfo,ItemStack> |
+DEFAULT_PREVIOUS_PAGE_ITEM |
+
static int |
+DEFAULT_PREVIOUS_PAGE_SLOT |
+
static MenuScheme |
+DEFAULT_SCHEME |
+
public static final int DEFAULT_LINES+
public static final int DEFAULT_NEXT_PAGE_SLOT+
public static final int DEFAULT_PREVIOUS_PAGE_SLOT+
public static final MenuScheme DEFAULT_SCHEME+
public static final Function<PageInfo,ItemStack> DEFAULT_NEXT_PAGE_ITEM+
public static PaginatedGuiBuilder create()+
public PaginatedGuiBuilder copy()+
public PaginatedGuiBuilder lines(int lines)+
public PaginatedGuiBuilder title(String title)+
public PaginatedGuiBuilder itemSlots(List<Integer> itemSlots)+
public PaginatedGuiBuilder nextPageSlot(int nextPageSlot)+
public PaginatedGuiBuilder previousPageSlot(int previousPageSlot)+
public PaginatedGuiBuilder scheme(MenuScheme scheme)+
public PaginatedGuiBuilder nextPageItem(Function<PageInfo,ItemStack> nextPageItem)+
public PaginatedGuiBuilder previousPageItem(Function<PageInfo,ItemStack> previousPageItem)+
public int getLines()+
public String getTitle()+
public int getNextPageSlot()+
public int getPreviousPageSlot()+
public MenuScheme getScheme()+
public PaginatedGui build(Player player, + Function<PaginatedGui,List<Item>> content)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PageInfo.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PageInfo.html new file mode 100644 index 00000000..3e6d2b35 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PageInfo.html @@ -0,0 +1,218 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.paginated | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static Function<PageInfo,ItemStack> |
+PaginatedGuiBuilder.DEFAULT_NEXT_PAGE_ITEM |
+
static Function<PageInfo,ItemStack> |
+PaginatedGuiBuilder.DEFAULT_PREVIOUS_PAGE_ITEM |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PageInfo |
+PageInfo.create(int current,
+ int size) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Function<PageInfo,ItemStack> |
+PaginatedGuiBuilder.getNextPageItem() |
+
Function<PageInfo,ItemStack> |
+PaginatedGuiBuilder.getPreviousPageItem() |
+
| Modifier and Type | +Method and Description | +
|---|---|
PaginatedGuiBuilder |
+PaginatedGuiBuilder.nextPageItem(Function<PageInfo,ItemStack> nextPageItem) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.previousPageItem(Function<PageInfo,ItemStack> previousPageItem) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PaginatedGui.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PaginatedGui.html new file mode 100644 index 00000000..04c772ff --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PaginatedGui.html @@ -0,0 +1,194 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.paginated | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PaginatedGui |
+PaginatedGuiBuilder.build(Player player,
+ Function<PaginatedGui,List<Item>> content) |
+
| Modifier and Type | +Method and Description | +
|---|---|
PaginatedGui |
+PaginatedGuiBuilder.build(Player player,
+ Function<PaginatedGui,List<Item>> content) |
+
| Constructor and Description | +
|---|
PaginatedGui(Function<PaginatedGui,List<Item>> content,
+ Player player,
+ PaginatedGuiBuilder model) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PaginatedGuiBuilder.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PaginatedGuiBuilder.html new file mode 100644 index 00000000..67020f23 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/class-use/PaginatedGuiBuilder.html @@ -0,0 +1,215 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.paginated | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PaginatedGuiBuilder |
+PaginatedGuiBuilder.copy() |
+
static PaginatedGuiBuilder |
+PaginatedGuiBuilder.create() |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.itemSlots(List<Integer> itemSlots) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.lines(int lines) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.nextPageItem(Function<PageInfo,ItemStack> nextPageItem) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.nextPageSlot(int nextPageSlot) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.previousPageItem(Function<PageInfo,ItemStack> previousPageItem) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.previousPageSlot(int previousPageSlot) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.scheme(MenuScheme scheme) |
+
PaginatedGuiBuilder |
+PaginatedGuiBuilder.title(String title) |
+
| Constructor and Description | +
|---|
PaginatedGui(Function<PaginatedGui,List<Item>> content,
+ Player player,
+ PaginatedGuiBuilder model) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-frame.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-frame.html new file mode 100644 index 00000000..01e8d82b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +| Class | +Description | +
|---|---|
| PageInfo | +
+ Represents data about a currently open page in a
+PaginatedGui. |
+
| PaginatedGui | ++ + | +
| PaginatedGuiBuilder | +
+ Specification class for a
+PaginatedGui. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-tree.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-tree.html new file mode 100644 index 00000000..2b4b697c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-tree.html @@ -0,0 +1,145 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-use.html b/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-use.html new file mode 100644 index 00000000..03bd6194 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/paginated/package-use.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.paginated | ++ |
| Class and Description | +
|---|
| PageInfo
+ Represents data about a currently open page in a
+PaginatedGui. |
+
| PaginatedGui + + | +
| PaginatedGuiBuilder
+ Specification class for a
+PaginatedGui. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/AbstractSchemeMapping.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/AbstractSchemeMapping.html new file mode 100644 index 00000000..fc2e0fe6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/AbstractSchemeMapping.html @@ -0,0 +1,363 @@ + + + + + + +public class AbstractSchemeMapping +extends Object +implements SchemeMapping+
SchemeMapping using an immutable map.| Modifier and Type | +Method and Description | +
|---|---|
SchemeMapping |
+copy()
+Makes a copy of this scheme mapping.
+ |
+
boolean |
+equals(Object obj) |
+
Item |
+getNullable(int key)
+Gets an item from the mapping which represents the given key.
+ |
+
int |
+hashCode() |
+
boolean |
+hasMappingFor(int key)
+Gets if this scheme has a mapping for a given key
+ |
+
static SchemeMapping |
+of(Map<Integer,Item> mapping) |
+
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitget@Nullable +public Item getNullable(int key)+
SchemeMappinggetNullable in interface SchemeMappingkey - the mapping keypublic boolean hasMappingFor(int key)+
SchemeMappinghasMappingFor in interface SchemeMappingkey - the mapping key@Nonnull +public SchemeMapping copy()+
SchemeMappingcopy in interface SchemeMappingCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/MenuPopulator.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/MenuPopulator.html new file mode 100644 index 00000000..b525050e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/MenuPopulator.html @@ -0,0 +1,454 @@ + + + + + + +@NonnullByDefault +public class MenuPopulator +extends Object+
Gui| Constructor and Description | +
|---|
MenuPopulator(Gui gui,
+ List<Integer> slots) |
+
MenuPopulator(Gui gui,
+ MenuScheme scheme) |
+
| Modifier and Type | +Method and Description | +
|---|---|
MenuPopulator |
+accept(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
MenuPopulator |
+acceptIfSpace(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
MenuPopulator |
+consume(Consumer<Slot> action) |
+
MenuPopulator |
+consumeIfSpace(Consumer<Slot> action) |
+
MenuPopulator |
+copy() |
+
int |
+getRemainingSpace()
+Gets the number of remaining slots in the populator.
+ |
+
ImmutableList<Integer> |
+getSlots()
+Gets an immutable copy of the slots used by this populator.
+ |
+
boolean |
+placeIfSpace(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
void |
+reset()
+Resets the slot order used by this populator to the state it was in upon construction
+ |
+
boolean |
+tryConsume(Consumer<Slot> action) |
+
public MenuPopulator(Gui gui, + MenuScheme scheme)+
public ImmutableList<Integer> getSlots()+
public void reset()+
public MenuPopulator consume(Consumer<Slot> action)+
public MenuPopulator consumeIfSpace(Consumer<Slot> action)+
public MenuPopulator accept(Item item)+
Gui using the next available slot in the populatoritem - the item to placeIllegalStateException - if there are not more slotspublic MenuPopulator acceptIfSpace(Item item)+
Gui using the next available slot in the populatoritem - the item to placepublic boolean placeIfSpace(Item item)+
Gui using the next available slot in the populatoritem - the item to placepublic int getRemainingSpace()+
public MenuPopulator copy()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/MenuScheme.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/MenuScheme.html new file mode 100644 index 00000000..c35610ae --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/MenuScheme.html @@ -0,0 +1,392 @@ + + + + + + +@NonnullByDefault +public class MenuScheme +extends Object+
| Constructor and Description | +
|---|
MenuScheme() |
+
MenuScheme(SchemeMapping mapping) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+apply(Gui gui) |
+
MenuScheme |
+copy() |
+
List<Integer> |
+getMaskedIndexes() |
+
ImmutableList<Integer> |
+getMaskedIndexesImmutable() |
+
MenuScheme |
+mask(String s) |
+
MenuScheme |
+maskEmpty(int lines) |
+
MenuScheme |
+masks(String... strings) |
+
MenuPopulator |
+newPopulator(Gui gui) |
+
MenuScheme |
+scheme(int... schemeIds) |
+
public MenuScheme(@Nullable + SchemeMapping mapping)+
public MenuScheme()+
public MenuScheme mask(String s)+
public MenuScheme masks(String... strings)+
public MenuScheme maskEmpty(int lines)+
public MenuScheme scheme(int... schemeIds)+
public void apply(Gui gui)+
public ImmutableList<Integer> getMaskedIndexesImmutable()+
public MenuPopulator newPopulator(Gui gui)+
public MenuScheme copy()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/SchemeMapping.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/SchemeMapping.html new file mode 100644 index 00000000..614addd3 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/SchemeMapping.html @@ -0,0 +1,304 @@ + + + + + + +public interface SchemeMapping
+MenuScheme| Modifier and Type | +Method and Description | +
|---|---|
SchemeMapping |
+copy()
+Makes a copy of this scheme mapping.
+ |
+
default Optional<Item> |
+get(int key)
+Gets an item from the mapping which represents the given key.
+ |
+
Item |
+getNullable(int key)
+Gets an item from the mapping which represents the given key.
+ |
+
boolean |
+hasMappingFor(int key)
+Gets if this scheme has a mapping for a given key
+ |
+
@Nonnull +default Optional<Item> get(int key)+
key - the mapping key@Nullable +Item getNullable(int key)+
key - the mapping keyboolean hasMappingFor(int key)+
key - the mapping key@Nonnull +SchemeMapping copy()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/StandardSchemeMappings.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/StandardSchemeMappings.html new file mode 100644 index 00000000..a7fe2d03 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/StandardSchemeMappings.html @@ -0,0 +1,295 @@ + + + + + + +@NonnullByDefault +public final class StandardSchemeMappings +extends Object+
SchemeMappings.| Modifier and Type | +Field and Description | +
|---|---|
static SchemeMapping |
+EMPTY |
+
static SchemeMapping |
+HARDENED_CLAY |
+
static SchemeMapping |
+STAINED_GLASS |
+
static SchemeMapping |
+STAINED_GLASS_BLOCK |
+
static SchemeMapping |
+WOOL |
+
public static final SchemeMapping STAINED_GLASS+
public static final SchemeMapping STAINED_GLASS_BLOCK+
public static final SchemeMapping HARDENED_CLAY+
public static final SchemeMapping WOOL+
public static final SchemeMapping EMPTY+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/AbstractSchemeMapping.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/AbstractSchemeMapping.html new file mode 100644 index 00000000..49190277 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/AbstractSchemeMapping.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/MenuPopulator.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/MenuPopulator.html new file mode 100644 index 00000000..2170d2aa --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/MenuPopulator.html @@ -0,0 +1,190 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.scheme | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
MenuPopulator |
+MenuPopulator.accept(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
MenuPopulator |
+MenuPopulator.acceptIfSpace(Item item)
+Places an item onto the
+Gui using the next available slot in the populator |
+
MenuPopulator |
+MenuPopulator.consume(Consumer<Slot> action) |
+
MenuPopulator |
+MenuPopulator.consumeIfSpace(Consumer<Slot> action) |
+
MenuPopulator |
+MenuPopulator.copy() |
+
MenuPopulator |
+MenuScheme.newPopulator(Gui gui) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/MenuScheme.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/MenuScheme.html new file mode 100644 index 00000000..94bf14b7 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/MenuScheme.html @@ -0,0 +1,242 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static MenuScheme |
+PaginatedGuiBuilder.DEFAULT_SCHEME |
+
| Modifier and Type | +Method and Description | +
|---|---|
MenuScheme |
+PaginatedGuiBuilder.getScheme() |
+
| Modifier and Type | +Method and Description | +
|---|---|
PaginatedGuiBuilder |
+PaginatedGuiBuilder.scheme(MenuScheme scheme) |
+
| Modifier and Type | +Method and Description | +
|---|---|
MenuScheme |
+MenuScheme.copy() |
+
MenuScheme |
+MenuScheme.mask(String s) |
+
MenuScheme |
+MenuScheme.maskEmpty(int lines) |
+
MenuScheme |
+MenuScheme.masks(String... strings) |
+
MenuScheme |
+MenuScheme.scheme(int... schemeIds) |
+
| Constructor and Description | +
|---|
MenuPopulator(Gui gui,
+ MenuScheme scheme) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/SchemeMapping.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/SchemeMapping.html new file mode 100644 index 00000000..adf9157f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/SchemeMapping.html @@ -0,0 +1,231 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.scheme | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractSchemeMapping
+Implements
+SchemeMapping using an immutable map. |
+
| Modifier and Type | +Field and Description | +
|---|---|
static SchemeMapping |
+StandardSchemeMappings.EMPTY |
+
static SchemeMapping |
+StandardSchemeMappings.HARDENED_CLAY |
+
static SchemeMapping |
+StandardSchemeMappings.STAINED_GLASS |
+
static SchemeMapping |
+StandardSchemeMappings.STAINED_GLASS_BLOCK |
+
static SchemeMapping |
+StandardSchemeMappings.WOOL |
+
| Modifier and Type | +Method and Description | +
|---|---|
SchemeMapping |
+SchemeMapping.copy()
+Makes a copy of this scheme mapping.
+ |
+
SchemeMapping |
+AbstractSchemeMapping.copy() |
+
static SchemeMapping |
+AbstractSchemeMapping.of(Map<Integer,Item> mapping) |
+
| Constructor and Description | +
|---|
MenuScheme(SchemeMapping mapping) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/StandardSchemeMappings.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/StandardSchemeMappings.html new file mode 100644 index 00000000..48e628eb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/class-use/StandardSchemeMappings.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-frame.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-frame.html new file mode 100644 index 00000000..9c2f96a5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-frame.html @@ -0,0 +1,28 @@ + + + + + + +| Interface | +Description | +
|---|---|
| SchemeMapping | +
+ Represents a mapping to be used in a
+MenuScheme |
+
| Class | +Description | +
|---|---|
| AbstractSchemeMapping | +
+ Implements
+SchemeMapping using an immutable map. |
+
| MenuPopulator | +
+ A utility to help place items into a
+Gui |
+
| MenuScheme | +
+ Helps to populate a menu with border items
+ |
+
| StandardSchemeMappings | +
+ Contains a number of default
+SchemeMappings. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-tree.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-tree.html new file mode 100644 index 00000000..8fc8740e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-tree.html @@ -0,0 +1,146 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-use.html b/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-use.html new file mode 100644 index 00000000..2c8909fe --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/menu/scheme/package-use.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| Class and Description | +
|---|
| MenuScheme
+ Helps to populate a menu with border items
+ |
+
| Class and Description | +
|---|
| MenuPopulator
+ A utility to help place items into a
+Gui |
+
| MenuScheme
+ Helps to populate a menu with border items
+ |
+
| SchemeMapping
+ Represents a mapping to be used in a
+MenuScheme |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/AbstractMessenger.html b/docs/javadoc/helper/me/lucko/helper/messaging/AbstractMessenger.html new file mode 100644 index 00000000..74fa7b0e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/AbstractMessenger.html @@ -0,0 +1,346 @@ + + + + + + +@NonnullByDefault +public class AbstractMessenger +extends Object +implements Messenger+
Messenger.
+
+ Outgoing messages are passed to a BiConsumer to be passed on.
Incoming messages can be distributed using registerIncomingMessage(String, String).
| Constructor and Description | +
|---|
AbstractMessenger(BiConsumer<String,String> outgoingMessages,
+ Consumer<String> notifySub,
+ Consumer<String> notifyUnsub)
+Creates a new abstract messenger
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> Channel<T> |
+getChannel(String name,
+ TypeToken<T> type)
+Gets a messaging channel by name.
+ |
+
void |
+registerIncomingMessage(String channel,
+ String message)
+Distributes an oncoming message to the channels held in this messenger.
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetChannel, getChannelpublic AbstractMessenger(BiConsumer<String,String> outgoingMessages, + Consumer<String> notifySub, + Consumer<String> notifyUnsub)+
outgoingMessages - the consumer to pass outgoing messages tonotifySub - the consumer to pass the names of channels which should be subscribed tonotifyUnsub - the consumer to pass the names of channels which should be unsubscribed frompublic void registerIncomingMessage(String channel, + String message)+
channel - the channel the message was received onmessage - the message@Nonnull +public <T> Channel<T> getChannel(@Nonnull + String name, + @Nonnull + TypeToken<T> type)+
MessengergetChannel in interface MessengerT - the channel message typename - the name of the channel.type - the channel message typetokenCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/Channel.html b/docs/javadoc/helper/me/lucko/helper/messaging/Channel.html new file mode 100644 index 00000000..6774701d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/Channel.html @@ -0,0 +1,318 @@ + + + + + + +T - the channel message typepublic interface Channel<T> +extends TypeAware<T>+
Channels can be subscribed to through a ChannelAgent.
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getName()
+Gets the name of the channel.
+ |
+
TypeToken<T> |
+getType()
+Gets the channels message type.
+ |
+
ChannelAgent<T> |
+newAgent()
+Creates a new
+ChannelAgent for this channel. |
+
CompletableFuture<Boolean> |
+sendMessage(T message)
+Sends a new message to the channel.
+ |
+
@Nonnull +String getName()+
@Nonnull +ChannelAgent<T> newAgent()+
ChannelAgent for this channel.@Nonnull +CompletableFuture<Boolean> sendMessage(@Nonnull + T message)+
This method will return immediately, and the future will be completed + once the message has been sent.
+ +The future will return true if the message was sent successfully.
message - the message to dispatchCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/ChannelAgent.html b/docs/javadoc/helper/me/lucko/helper/messaging/ChannelAgent.html new file mode 100644 index 00000000..4a5a8d23 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/ChannelAgent.html @@ -0,0 +1,350 @@ + + + + + + +T - the channel message typepublic interface ChannelAgent<T> +extends Terminable+
Channels message streams.EMPTY| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+addListener(ChannelListener<T> listener)
+Adds a new listener to the channel;
+ |
+
Channel<T> |
+getChannel()
+Gets the channel this agent is acting for.
+ |
+
Set<ChannelListener<T>> |
+getListeners()
+Gets an immutable copy of the listeners currently held by this agent.
+ |
+
boolean |
+hasListeners()
+Gets if this agent has any active listeners.
+ |
+
boolean |
+removeListener(ChannelListener<T> listener)
+Removes a listener from the channel.
+ |
+
bindWith, hasTerminated, of, terminate@Nonnull +Channel<T> getChannel()+
@Nonnull +Set<ChannelListener<T>> getListeners()+
boolean hasListeners()+
boolean addListener(@Nonnull + ChannelListener<T> listener)+
listener - the listener to addboolean removeListener(@Nonnull + ChannelListener<T> listener)+
listener - the listener to removeCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/ChannelListener.html b/docs/javadoc/helper/me/lucko/helper/messaging/ChannelListener.html new file mode 100644 index 00000000..90d5c42e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/ChannelListener.html @@ -0,0 +1,249 @@ + + + + + + +T - the channel message type@FunctionalInterface +public interface ChannelListener<T>+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+onMessage(ChannelAgent<T> agent,
+ T message)
+Called when a message is posted to this listener.
+ |
+
void onMessage(@Nonnull + ChannelAgent<T> agent, + @Nonnull + T message)+
This method is called asynchronously.
agent - the agent which forwarded the message.message - the messageCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/InstanceData.html b/docs/javadoc/helper/me/lucko/helper/messaging/InstanceData.html new file mode 100644 index 00000000..17267e3e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/InstanceData.html @@ -0,0 +1,253 @@ + + + + + + +public interface InstanceData
+| Modifier and Type | +Method and Description | +
|---|---|
Set<String> |
+getGroups()
+Gets the groups this server is a member of.
+ |
+
String |
+getId()
+Gets the unique ID of the current server instance.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/Messenger.html b/docs/javadoc/helper/me/lucko/helper/messaging/Messenger.html new file mode 100644 index 00000000..3db13967 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/Messenger.html @@ -0,0 +1,299 @@ + + + + + + +public interface Messenger
+Channels.| Modifier and Type | +Method and Description | +
|---|---|
default Channel<String> |
+getChannel(String name)
+Gets a messaging channel by name, with the String type.
+ |
+
default <T> Channel<T> |
+getChannel(String name,
+ Class<T> clazz)
+Gets a messaging channel by name.
+ |
+
<T> Channel<T> |
+getChannel(String name,
+ TypeToken<T> type)
+Gets a messaging channel by name.
+ |
+
@Nonnull +<T> Channel<T> getChannel(@Nonnull + String name, + @Nonnull + TypeToken<T> type)+
T - the channel message typename - the name of the channel.type - the channel message typetoken@Nonnull +default <T> Channel<T> getChannel(@Nonnull + String name, + @Nonnull + Class<T> clazz)+
T - the channel message typename - the name of the channel.clazz - the channel message classCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/bungee/BungeeMessaging.html b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/BungeeMessaging.html new file mode 100644 index 00000000..3ca6e522 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/BungeeMessaging.html @@ -0,0 +1,752 @@ + + + + + + +@NonnullByDefault +public final class BungeeMessaging +extends Object +implements PluginMessageListener+
See: https://www.spigotmc.org/wiki/bukkit-bungee-plugin-messaging-channel and + https://github.com/SpigotMC/BungeeCord/blob/master/proxy/src/main/java/net/md_5/bungee/connection/DownstreamBridge.java#L223
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+ALL_SERVERS
+Server name to represent all servers on the proxy
+ |
+
static String |
+ONLINE_SERVERS
+Server name to represent only the online servers on the proxy
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+connect(Player player,
+ String serverName)
+Connects a player to said subserver
+ |
+
static void |
+connectOther(String playerName,
+ String serverName)
+Connects a named player to said subserver
+ |
+
static void |
+forward(String serverName,
+ String channelName,
+ byte[] data)
+Sends a custom plugin message to a given server.
+ |
+
static void |
+forward(String serverName,
+ String channelName,
+ ByteArrayDataOutput data)
+Sends a custom plugin message to a given server.
+ |
+
static void |
+forwardToPlayer(String playerName,
+ String channelName,
+ byte[] data)
+Sends a custom plugin message to a given server.
+ |
+
static void |
+forwardToPlayer(String playerName,
+ String channelName,
+ ByteArrayDataOutput data)
+Sends a custom plugin message to a given server.
+ |
+
static void |
+getServer(Consumer<String> callback)
+Gets this servers name, as defined in the BungeeCord config
+ |
+
static void |
+getServers(Consumer<List<String>> callback)
+Get a list of server name strings, as defined in the BungeeCord config
+ |
+
static void |
+ip(Player player,
+ Consumer<Map.Entry<String,Integer>> callback)
+Get the real IP of a player
+ |
+
static void |
+kickPlayer(String playerName,
+ String reason)
+Kick a player from the proxy
+ |
+
static void |
+message(String playerName,
+ String message)
+Send a message (as in chat message) to the specified player
+ |
+
void |
+onPluginMessageReceived(String channel,
+ Player player,
+ byte[] data) |
+
static void |
+playerCount(String serverName,
+ Consumer<Integer> callback)
+Gets the amount of players on a certain server, or all servers
+ |
+
static void |
+playerList(String serverName,
+ Consumer<List<String>> callback)
+Gets a list of players connected on a certain server, or all servers.
+ |
+
static void |
+registerForwardCallback(String channelName,
+ Predicate<ByteArrayDataInput> callback)
+Registers a callback to listen for messages sent on forwarded subchannels.
+ |
+
static void |
+registerForwardCallbackRaw(String channelName,
+ Predicate<byte[]> callback)
+Registers a callback to listen for messages sent on forwarded subchannels.
+ |
+
static void |
+serverIp(String serverName,
+ Consumer<Map.Entry<String,Integer>> callback)
+Get the IP of any server connected to the proxy
+ |
+
static void |
+uuid(Player player,
+ Consumer<UUID> callback)
+Get the UUID of a player
+ |
+
static void |
+uuidOther(String playerName,
+ Consumer<UUID> callback)
+Get the UUID of any player connected to the proxy
+ |
+
public static final String ALL_SERVERS+
public static final String ONLINE_SERVERS+
public static void connect(Player player, + String serverName)+
player - the player to connectserverName - the name of the server to connect topublic static void connectOther(String playerName, + String serverName)+
playerName - the username of the player to connectserverName - the name of the server to connect topublic static void ip(Player player, + Consumer<Map.Entry<String,Integer>> callback)+
player - the player to get the IP ofcallback - a callback to consume the ip and portpublic static void playerCount(String serverName, + Consumer<Integer> callback)+
serverName - the name of the server to get the player count for. Use ALL_SERVERS to get the global countcallback - a callback to consume the countpublic static void playerList(String serverName, + Consumer<List<String>> callback)+
serverName - the name of the server to get the player list for. Use ALL_SERVERS to get the global listcallback - a callback to consume the player listpublic static void getServers(Consumer<List<String>> callback)+
callback - a callback to consume the list of server namespublic static void message(String playerName, + String message)+
playerName - the username of the player to send the message tomessage - the message to sendpublic static void getServer(Consumer<String> callback)+
callback - a callback to consume the namepublic static void uuid(Player player, + Consumer<UUID> callback)+
player - the player to get the uuid ofcallback - a callback to consume the uuidpublic static void uuidOther(String playerName, + Consumer<UUID> callback)+
playerName - the username of the player to get the uuid ofcallback - a callback to consume the uuidpublic static void serverIp(String serverName, + Consumer<Map.Entry<String,Integer>> callback)+
serverName - the name of the server to get the ip ofcallback - a callback to consume the ip and portpublic static void kickPlayer(String playerName, + String reason)+
playerName - the username of the player to kickreason - the reason to display to the player when they are kickedpublic static void forward(String serverName, + String channelName, + byte[] data)+
You can use registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.
serverName - the name of the server to send to. use ALL_SERVERS to send to all servers, or ONLINE_SERVERS to only send to servers which are online.channelName - the name of the subchanneldata - the data to sendpublic static void forward(String serverName, + String channelName, + ByteArrayDataOutput data)+
You can use registerForwardCallback(String, Predicate) to register listeners on a given subchannel.
serverName - the name of the server to send to. use ALL_SERVERS to send to all servers, or ONLINE_SERVERS to only send to servers which are online.channelName - the name of the subchanneldata - the data to sendpublic static void forwardToPlayer(String playerName, + String channelName, + byte[] data)+
You can use registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.
playerName - the username of a player. BungeeCord will send the forward message to their server.channelName - the name of the subchanneldata - the data to sendpublic static void forwardToPlayer(String playerName, + String channelName, + ByteArrayDataOutput data)+
You can use registerForwardCallback(String, Predicate) to register listeners on a given subchannel.
playerName - the username of a player. BungeeCord will send the forward message to their server.channelName - the name of the subchanneldata - the data to sendpublic static void registerForwardCallbackRaw(String channelName, + Predicate<byte[]> callback)+
Use forward(String, String, byte[]) to dispatch messages.
channelName - the name of the channel to listen oncallback - the callback. the predicate should return true when the callback should be unregistered.public static void registerForwardCallback(String channelName, + Predicate<ByteArrayDataInput> callback)+
Use forward(String, String, ByteArrayDataOutput) to dispatch messages.
channelName - the name of the channel to listen oncallback - the callback. the predicate should return true when the callback should be unregistered.public void onPluginMessageReceived(String channel, + Player player, + byte[] data)+
onPluginMessageReceived in interface PluginMessageListenerCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/bungee/class-use/BungeeMessaging.html b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/class-use/BungeeMessaging.html new file mode 100644 index 00000000..10659b8f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/class-use/BungeeMessaging.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-frame.html b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-frame.html new file mode 100644 index 00000000..5fe65461 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| BungeeMessaging | +
+ Wrapper class for the BungeeCord Plugin Messaging API, providing callbacks to read response data
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-tree.html b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-tree.html new file mode 100644 index 00000000..a2bbd06e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-use.html b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-use.html new file mode 100644 index 00000000..9ea0a4ce --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/bungee/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/class-use/AbstractMessenger.html b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/AbstractMessenger.html new file mode 100644 index 00000000..b796981c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/AbstractMessenger.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/class-use/Channel.html b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/Channel.html new file mode 100644 index 00000000..25f41292 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/Channel.html @@ -0,0 +1,193 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Channel<T> |
+ChannelAgent.getChannel()
+Gets the channel this agent is acting for.
+ |
+
default Channel<String> |
+Messenger.getChannel(String name)
+Gets a messaging channel by name, with the String type.
+ |
+
default <T> Channel<T> |
+Messenger.getChannel(String name,
+ Class<T> clazz)
+Gets a messaging channel by name.
+ |
+
<T> Channel<T> |
+Messenger.getChannel(String name,
+ TypeToken<T> type)
+Gets a messaging channel by name.
+ |
+
<T> Channel<T> |
+AbstractMessenger.getChannel(String name,
+ TypeToken<T> type) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/class-use/ChannelAgent.html b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/ChannelAgent.html new file mode 100644 index 00000000..c5edb033 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/ChannelAgent.html @@ -0,0 +1,184 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ChannelAgent<T> |
+Channel.newAgent()
+Creates a new
+ChannelAgent for this channel. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ChannelListener.onMessage(ChannelAgent<T> agent,
+ T message)
+Called when a message is posted to this listener.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/class-use/ChannelListener.html b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/ChannelListener.html new file mode 100644 index 00000000..3bfdf03e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/ChannelListener.html @@ -0,0 +1,189 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Set<ChannelListener<T>> |
+ChannelAgent.getListeners()
+Gets an immutable copy of the listeners currently held by this agent.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+ChannelAgent.addListener(ChannelListener<T> listener)
+Adds a new listener to the channel;
+ |
+
boolean |
+ChannelAgent.removeListener(ChannelListener<T> listener)
+Removes a listener from the channel.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/class-use/InstanceData.html b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/InstanceData.html new file mode 100644 index 00000000..8ceaf255 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/InstanceData.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/class-use/Messenger.html b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/Messenger.html new file mode 100644 index 00000000..6c618856 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/class-use/Messenger.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractMessenger
+An abstract implementation of
+Messenger. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/package-frame.html b/docs/javadoc/helper/me/lucko/helper/messaging/package-frame.html new file mode 100644 index 00000000..85fa78db --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/package-frame.html @@ -0,0 +1,29 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Channel<T> | +
+ Represents an individual messaging channel.
+ |
+
| ChannelAgent<T> | +
+ Represents an agent for interacting with a
+Channels message streams. |
+
| ChannelListener<T> | +
+ Represents an object listening to messages sent on the channel.
+ |
+
| InstanceData | +
+ Provides information about the current server instance.
+ |
+
| Messenger | +
+ Represents an object which manages messaging
+Channels. |
+
| Class | +Description | +
|---|---|
| AbstractMessenger | +
+ An abstract implementation of
+Messenger. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/package-tree.html b/docs/javadoc/helper/me/lucko/helper/messaging/package-tree.html new file mode 100644 index 00000000..0b14371a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/messaging/package-use.html b/docs/javadoc/helper/me/lucko/helper/messaging/package-use.html new file mode 100644 index 00000000..8bd296a1 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/messaging/package-use.html @@ -0,0 +1,176 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.messaging | ++ |
| Class and Description | +
|---|
| Channel
+ Represents an individual messaging channel.
+ |
+
| ChannelAgent
+ Represents an agent for interacting with a
+Channels message streams. |
+
| ChannelListener
+ Represents an object listening to messages sent on the channel.
+ |
+
| Messenger
+ Represents an object which manages messaging
+Channels. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/Empty.html b/docs/javadoc/helper/me/lucko/helper/metadata/Empty.html new file mode 100644 index 00000000..0e2beae5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/Empty.html @@ -0,0 +1,280 @@ + + + + + + +public final class Empty +extends Object+
Used mostly by MetadataKeys, where the presence of the key in the map
+ is enough for a behaviour to apply. In other words, the value is not significant.
Very similar to Void, except this class also provides an instance of the "empty" object.
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object obj) |
+
static Empty |
+instance() |
+
String |
+toString() |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/ExpiringValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/ExpiringValue.html new file mode 100644 index 00000000..7aaed19b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/ExpiringValue.html @@ -0,0 +1,302 @@ + + + + + + +T - the wrapped value typepublic final class ExpiringValue<T> +extends Object +implements TransientValue<T>+
| Modifier and Type | +Method and Description | +
|---|---|
T |
+getOrNull()
+Returns the underlying value, or null if it has expired
+ |
+
static <T> ExpiringValue<T> |
+of(T value,
+ long duration,
+ TimeUnit unit) |
+
boolean |
+shouldExpire()
+Returns if this value should be removed from the map
+ |
+
public static <T> ExpiringValue<T> of(T value, + long duration, + TimeUnit unit)+
@Nullable +public T getOrNull()+
TransientValuegetOrNull in interface TransientValue<T>public boolean shouldExpire()+
TransientValueshouldExpire in interface TransientValue<T>Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/Metadata.html b/docs/javadoc/helper/me/lucko/helper/metadata/Metadata.html new file mode 100644 index 00000000..7de6a0e5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/Metadata.html @@ -0,0 +1,483 @@ + + + + + + +public final class Metadata +extends Object+
MetadataMaps bound to players, entities, blocks and worlds.| Modifier and Type | +Method and Description | +
|---|---|
static <T> Map<BlockPosition,T> |
+lookupBlocksWithKey(MetadataKey<T> key)
+Gets a map of the blocks with a given metadata key
+ |
+
static <T> Map<Entity,T> |
+lookupEntitiesWithKey(MetadataKey<T> key)
+Gets a map of the entities with a given metadata key
+ |
+
static <T> Map<Player,T> |
+lookupPlayersWithKey(MetadataKey<T> key)
+Gets a map of the players with a given metadata key
+ |
+
static <T> Map<World,T> |
+lookupWorldsWithKey(MetadataKey<T> key)
+Gets a map of the worlds with a given metadata key
+ |
+
static MetadataMap |
+provide(Object obj)
+Gets a metadata map for the given object.
+ |
+
static MetadataMap |
+provideForBlock(Block block)
+Gets a MetadataMap for the given block.
+ |
+
static MetadataMap |
+provideForEntity(Entity entity)
+Gets a MetadataMap for the given entity.
+ |
+
static MetadataMap |
+provideForPlayer(Player player)
+Gets a MetadataMap for the given player.
+ |
+
static MetadataMap |
+provideForPlayer(UUID uuid)
+Gets a MetadataMap for the given player.
+ |
+
static MetadataMap |
+provideForWorld(World world)
+Gets a MetadataMap for the given world.
+ |
+
@Nonnull +public static MetadataMap provide(@Nonnull + Object obj)+
Player, UUID, Entity, Block or World.obj - the object@Nonnull +public static MetadataMap provideForPlayer(@Nonnull + Player player)+
player - the player@Nonnull +public static MetadataMap provideForPlayer(@Nonnull + UUID uuid)+
uuid - the players uuid@Nonnull +public static <T> Map<Player,T> lookupPlayersWithKey(@Nonnull + MetadataKey<T> key)+
T - the key typekey - the key@Nonnull +public static MetadataMap provideForEntity(@Nonnull + Entity entity)+
entity - the entity@Nonnull +public static <T> Map<Entity,T> lookupEntitiesWithKey(@Nonnull + MetadataKey<T> key)+
T - the key typekey - the key@Nonnull +public static MetadataMap provideForBlock(@Nonnull + Block block)+
block - the block@Nonnull +public static <T> Map<BlockPosition,T> lookupBlocksWithKey(@Nonnull + MetadataKey<T> key)+
T - the key typekey - the key@Nonnull +public static MetadataMap provideForWorld(@Nonnull + World world)+
world - the world@Nonnull +public static <T> Map<World,T> lookupWorldsWithKey(@Nonnull + MetadataKey<T> key)+
T - the key typekey - the keyCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/MetadataKey.html b/docs/javadoc/helper/me/lucko/helper/metadata/MetadataKey.html new file mode 100644 index 00000000..02c1e438 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/MetadataKey.html @@ -0,0 +1,487 @@ + + + + + + +T - the value type@NonnullByDefault +public interface MetadataKey<T> +extends TypeAware<T>+
MetadataMap.
+
+ Unlike a normal map key, a MetadataKey also holds the type of the values mapped to it.
| Modifier and Type | +Method and Description | +
|---|---|
T |
+cast(Object object)
+Attempts to cast the given object to the return type of the key
+ |
+
static <T> MetadataKey<T> |
+create(String id,
+ Class<T> clazz)
+Creates a MetadataKey with the given id and type
+ |
+
static <T> MetadataKey<T> |
+create(String id,
+ TypeToken<T> type)
+Creates a MetadataKey with the given id and type
+ |
+
static MetadataKey<Boolean> |
+createBooleanKey(String id) |
+
static MetadataKey<Character> |
+createCharacterKey(String id) |
+
static MetadataKey<Cooldown> |
+createCooldownKey(String id) |
+
static MetadataKey<Double> |
+createDoubleKey(String id) |
+
static MetadataKey<Empty> |
+createEmptyKey(String id) |
+
static MetadataKey<Float> |
+createFloatKey(String id) |
+
static MetadataKey<Integer> |
+createIntegerKey(String id) |
+
static MetadataKey<Long> |
+createLongKey(String id) |
+
static MetadataKey<Short> |
+createShortKey(String id) |
+
static MetadataKey<String> |
+createStringKey(String id) |
+
static MetadataKey<UUID> |
+createUuidKey(String id) |
+
String |
+getId()
+Gets the id of this key.
+ |
+
TypeToken<T> |
+getType()
+Get the type of the value mapped to this key
+ |
+
static <T> MetadataKey<T> create(String id, + TypeToken<T> type)+
T - the value typeid - the id of the keytype - the type of the value mapped to this keystatic <T> MetadataKey<T> create(String id, + Class<T> clazz)+
T - the value typeid - the id of the keyclazz - the class type of the value mapped to this keystatic MetadataKey<Empty> createEmptyKey(String id)+
static MetadataKey<String> createStringKey(String id)+
static MetadataKey<Boolean> createBooleanKey(String id)+
static MetadataKey<Integer> createIntegerKey(String id)+
static MetadataKey<Long> createLongKey(String id)+
static MetadataKey<Double> createDoubleKey(String id)+
static MetadataKey<Float> createFloatKey(String id)+
static MetadataKey<Short> createShortKey(String id)+
static MetadataKey<Character> createCharacterKey(String id)+
static MetadataKey<Cooldown> createCooldownKey(String id)+
static MetadataKey<UUID> createUuidKey(String id)+
String getId()+
T cast(Object object) +throws ClassCastException+
object - the object to be castedClassCastException - if the object cannot be castedCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/MetadataMap.html b/docs/javadoc/helper/me/lucko/helper/metadata/MetadataMap.html new file mode 100644 index 00000000..217e521e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/MetadataMap.html @@ -0,0 +1,706 @@ + + + + + + +public interface MetadataMap
+MetadataKeys, and maps them to persistent or transient (expiring / weak) values.
+
+ Transient values will only be removed during map maintenance, which occurs during a housekeeping task running
+ every minute. Method signatures for the has(MetadataKey) and equivalent remain accurate though.TransientValue| Modifier and Type | +Method and Description | +
|---|---|
ImmutableMap<MetadataKey<?>,Object> |
+asMap()
+Returns an immutable view of the backing map
+ |
+
void |
+clear()
+Clears the map
+ |
+
static MetadataMap |
+create() |
+
<T> void |
+forcePut(MetadataKey<T> key,
+ T value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> void |
+forcePut(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> Optional<T> |
+get(MetadataKey<T> key)
+Gets an optional value for the given key.
+ |
+
<T> T |
+getOrDefault(MetadataKey<T> key,
+ T def)
+Gets a value for the given key, or returns the default if one isn't present.
+ |
+
<T> T |
+getOrNull(MetadataKey<T> key)
+Gets a value for the given key, or null if one isn't present.
+ |
+
<T> T |
+getOrPut(MetadataKey<T> key,
+ Supplier<T> def)
+Gets a value for the given key, or puts and returns the default if one isn't present.
+ |
+
<T> T |
+getOrPutExpiring(MetadataKey<T> key,
+ Supplier<TransientValue<T>> def)
+Gets a value for the given key, or puts and returns the default if one isn't present.
+ |
+
boolean |
+has(MetadataKey<?> key)
+Returns if this map contains the given key, and the types of each key match.
+ |
+
<T> boolean |
+ifPresent(MetadataKey<T> key,
+ Consumer<? super T> action)
+Attempts to get a value for the given key, and applies the action is present.
+ |
+
boolean |
+isEmpty()
+Returns if the map is empty
+ |
+
<T> void |
+put(MetadataKey<T> key,
+ T value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> void |
+put(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> boolean |
+putIfAbsent(MetadataKey<T> key,
+ T value)
+Adds a metadata key and corresponding value into this map, only if an existing key is not present.
+ |
+
<T> boolean |
+putIfAbsent(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, only if an existing key is not present.
+ |
+
boolean |
+remove(MetadataKey<?> key)
+Removes the given key from this map
+ |
+
@Nonnull +static MetadataMap create()+
<T> void put(@Nonnull + MetadataKey<T> key, + @Nonnull + T value)+
ClassCastException will be
+ thrown if they do not share the same type, and the existing value will remain.T - the value typekey - the key to putvalue - the value to map against (non null)ClassCastException - if any existing key with the same id has a differing type to the key being add<T> void put(@Nonnull + MetadataKey<T> key, + @Nonnull + TransientValue<T> value)+
ClassCastException will be
+ thrown if they do not share the same type, and the existing value will remain.T - the value typekey - the key to putvalue - the value to map against (non null)ClassCastException - if any existing key with the same id has a differing type to the key being add<T> void forcePut(@Nonnull + MetadataKey<T> key, + @Nonnull + T value)+
put(MetadataKey, Object), the existing value if present does not need to have the same type.T - the value typekey - the key to putvalue - the value to map against (non null)<T> void forcePut(@Nonnull + MetadataKey<T> key, + @Nonnull + TransientValue<T> value)+
put(MetadataKey, Object), the existing value if present does not need to have the same type.T - the value typekey - the key to putvalue - the value to map against (non null)<T> boolean putIfAbsent(@Nonnull + MetadataKey<T> key, + @Nonnull + T value)+
T - the value typekey - the key to putvalue - the value to map against (non null)<T> boolean putIfAbsent(@Nonnull + MetadataKey<T> key, + @Nonnull + TransientValue<T> value)+
T - the value typekey - the key to putvalue - the value to map against (non null)@Nonnull +<T> Optional<T> get(@Nonnull + MetadataKey<T> key)+
T - the value typekey - the metadata key to getClassCastException - if there is a key held in the map with the same id but differing type to the given key.<T> boolean ifPresent(@Nonnull + MetadataKey<T> key, + @Nonnull + Consumer<? super T> action)+
T - the value typekey - the metadata key to lookupaction - the action to applyClassCastException - if there is a key held in the map with the same id but differing type to the given key.@Nullable +<T> T getOrNull(@Nonnull + MetadataKey<T> key)+
T - the value typekey - the metadata key to getClassCastException - if there is a key held in the map with the same id but differing type to the given key.@Nonnull +<T> T getOrDefault(@Nonnull + MetadataKey<T> key, + @Nullable + T def)+
T - the value typekey - the metadata key to getdef - the default valueClassCastException - if there is a key held in the map with the same id but differing type to the given key.@Nonnull +<T> T getOrPut(@Nonnull + MetadataKey<T> key, + @Nonnull + Supplier<T> def)+
T - the value typekey - the metadata key to getdef - the default valueClassCastException - if there is a key held in the map with the same id but differing type to the given key.@Nonnull +<T> T getOrPutExpiring(@Nonnull + MetadataKey<T> key, + @Nonnull + Supplier<TransientValue<T>> def)+
T - the value typekey - the metadata key to getdef - the default valueClassCastException - if there is a key held in the map with the same id but differing type to the given key.boolean has(@Nonnull + MetadataKey<?> key)+
key - the key to check forboolean remove(@Nonnull + MetadataKey<?> key)+
key - the key to removevoid clear()+
@Nonnull +ImmutableMap<MetadataKey<?>,Object> asMap()+
boolean isEmpty()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/SoftValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/SoftValue.html new file mode 100644 index 00000000..7bf16af8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/SoftValue.html @@ -0,0 +1,298 @@ + + + + + + +T - the wrapped value typepublic final class SoftValue<T> +extends Object +implements TransientValue<T>+
SoftReference| Modifier and Type | +Method and Description | +
|---|---|
T |
+getOrNull()
+Returns the underlying value, or null if it has expired
+ |
+
static <T> SoftValue<T> |
+of(T value) |
+
boolean |
+shouldExpire()
+Returns if this value should be removed from the map
+ |
+
public static <T> SoftValue<T> of(T value)+
@Nullable +public T getOrNull()+
TransientValuegetOrNull in interface TransientValue<T>public boolean shouldExpire()+
TransientValueshouldExpire in interface TransientValue<T>Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/TransientValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/TransientValue.html new file mode 100644 index 00000000..f9c6ca5f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/TransientValue.html @@ -0,0 +1,260 @@ + + + + + + +T - the type of the underlying valuepublic interface TransientValue<T>
+MetadataMap which will automatically expire at some point.| Modifier and Type | +Method and Description | +
|---|---|
T |
+getOrNull()
+Returns the underlying value, or null if it has expired
+ |
+
boolean |
+shouldExpire()
+Returns if this value should be removed from the map
+ |
+
@Nullable +T getOrNull()+
boolean shouldExpire()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/WeakValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/WeakValue.html new file mode 100644 index 00000000..bd2a1b79 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/WeakValue.html @@ -0,0 +1,298 @@ + + + + + + +T - the wrapped value typepublic final class WeakValue<T> +extends Object +implements TransientValue<T>+
WeakReference| Modifier and Type | +Method and Description | +
|---|---|
T |
+getOrNull()
+Returns the underlying value, or null if it has expired
+ |
+
static <T> WeakValue<T> |
+of(T value) |
+
boolean |
+shouldExpire()
+Returns if this value should be removed from the map
+ |
+
public static <T> WeakValue<T> of(T value)+
@Nullable +public T getOrNull()+
TransientValuegetOrNull in interface TransientValue<T>public boolean shouldExpire()+
TransientValueshouldExpire in interface TransientValue<T>Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/Empty.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/Empty.html new file mode 100644 index 00000000..6f8208c8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/Empty.html @@ -0,0 +1,179 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Empty |
+Empty.instance() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static MetadataKey<Empty> |
+MetadataKey.createEmptyKey(String id) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/ExpiringValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/ExpiringValue.html new file mode 100644 index 00000000..5cfc9a68 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/ExpiringValue.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static <T> ExpiringValue<T> |
+ExpiringValue.of(T value,
+ long duration,
+ TimeUnit unit) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/Metadata.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/Metadata.html new file mode 100644 index 00000000..f912ca82 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/Metadata.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/MetadataKey.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/MetadataKey.html new file mode 100644 index 00000000..5d2ec163 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/MetadataKey.html @@ -0,0 +1,414 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
<T extends EntityEvent> |
+Events.DefaultFilters.entityHasMetadata(MetadataKey<?> key)
+Returns a predicate which only returns true if the entity has a given metadata key
+ |
+
<T extends PlayerEvent> |
+Events.DefaultFilters.playerHasMetadata(MetadataKey<?> key)
+Returns a predicate which only returns true if the player has a given metadata key
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static MetadataKey<Gui> |
+Gui.OPEN_GUI_KEY |
+
| Modifier and Type | +Method and Description | +
|---|---|
static <T> MetadataKey<T> |
+MetadataKey.create(String id,
+ Class<T> clazz)
+Creates a MetadataKey with the given id and type
+ |
+
static <T> MetadataKey<T> |
+MetadataKey.create(String id,
+ TypeToken<T> type)
+Creates a MetadataKey with the given id and type
+ |
+
static MetadataKey<Boolean> |
+MetadataKey.createBooleanKey(String id) |
+
static MetadataKey<Character> |
+MetadataKey.createCharacterKey(String id) |
+
static MetadataKey<Cooldown> |
+MetadataKey.createCooldownKey(String id) |
+
static MetadataKey<Double> |
+MetadataKey.createDoubleKey(String id) |
+
static MetadataKey<Empty> |
+MetadataKey.createEmptyKey(String id) |
+
static MetadataKey<Float> |
+MetadataKey.createFloatKey(String id) |
+
static MetadataKey<Integer> |
+MetadataKey.createIntegerKey(String id) |
+
static MetadataKey<Long> |
+MetadataKey.createLongKey(String id) |
+
static MetadataKey<Short> |
+MetadataKey.createShortKey(String id) |
+
static MetadataKey<String> |
+MetadataKey.createStringKey(String id) |
+
static MetadataKey<UUID> |
+MetadataKey.createUuidKey(String id) |
+
| Modifier and Type | +Method and Description | +
|---|---|
ImmutableMap<MetadataKey<?>,Object> |
+MetadataMap.asMap()
+Returns an immutable view of the backing map
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> void |
+MetadataMap.forcePut(MetadataKey<T> key,
+ T value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> void |
+MetadataMap.forcePut(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> Optional<T> |
+MetadataMap.get(MetadataKey<T> key)
+Gets an optional value for the given key.
+ |
+
<T> T |
+MetadataMap.getOrDefault(MetadataKey<T> key,
+ T def)
+Gets a value for the given key, or returns the default if one isn't present.
+ |
+
<T> T |
+MetadataMap.getOrNull(MetadataKey<T> key)
+Gets a value for the given key, or null if one isn't present.
+ |
+
<T> T |
+MetadataMap.getOrPut(MetadataKey<T> key,
+ Supplier<T> def)
+Gets a value for the given key, or puts and returns the default if one isn't present.
+ |
+
<T> T |
+MetadataMap.getOrPutExpiring(MetadataKey<T> key,
+ Supplier<TransientValue<T>> def)
+Gets a value for the given key, or puts and returns the default if one isn't present.
+ |
+
boolean |
+MetadataMap.has(MetadataKey<?> key)
+Returns if this map contains the given key, and the types of each key match.
+ |
+
<T> boolean |
+MetadataMap.ifPresent(MetadataKey<T> key,
+ Consumer<? super T> action)
+Attempts to get a value for the given key, and applies the action is present.
+ |
+
static <T> Map<BlockPosition,T> |
+Metadata.lookupBlocksWithKey(MetadataKey<T> key)
+Gets a map of the blocks with a given metadata key
+ |
+
static <T> Map<Entity,T> |
+Metadata.lookupEntitiesWithKey(MetadataKey<T> key)
+Gets a map of the entities with a given metadata key
+ |
+
static <T> Map<Player,T> |
+Metadata.lookupPlayersWithKey(MetadataKey<T> key)
+Gets a map of the players with a given metadata key
+ |
+
static <T> Map<World,T> |
+Metadata.lookupWorldsWithKey(MetadataKey<T> key)
+Gets a map of the worlds with a given metadata key
+ |
+
<T> void |
+MetadataMap.put(MetadataKey<T> key,
+ T value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> void |
+MetadataMap.put(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> boolean |
+MetadataMap.putIfAbsent(MetadataKey<T> key,
+ T value)
+Adds a metadata key and corresponding value into this map, only if an existing key is not present.
+ |
+
<T> boolean |
+MetadataMap.putIfAbsent(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, only if an existing key is not present.
+ |
+
boolean |
+MetadataMap.remove(MetadataKey<?> key)
+Removes the given key from this map
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/MetadataMap.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/MetadataMap.html new file mode 100644 index 00000000..46678f84 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/MetadataMap.html @@ -0,0 +1,202 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static MetadataMap |
+MetadataMap.create() |
+
static MetadataMap |
+Metadata.provide(Object obj)
+Gets a metadata map for the given object.
+ |
+
static MetadataMap |
+Metadata.provideForBlock(Block block)
+Gets a MetadataMap for the given block.
+ |
+
static MetadataMap |
+Metadata.provideForEntity(Entity entity)
+Gets a MetadataMap for the given entity.
+ |
+
static MetadataMap |
+Metadata.provideForPlayer(Player player)
+Gets a MetadataMap for the given player.
+ |
+
static MetadataMap |
+Metadata.provideForPlayer(UUID uuid)
+Gets a MetadataMap for the given player.
+ |
+
static MetadataMap |
+Metadata.provideForWorld(World world)
+Gets a MetadataMap for the given world.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/SoftValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/SoftValue.html new file mode 100644 index 00000000..dfc82d45 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/SoftValue.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static <T> SoftValue<T> |
+SoftValue.of(T value) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/TransientValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/TransientValue.html new file mode 100644 index 00000000..ff20682e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/TransientValue.html @@ -0,0 +1,226 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ExpiringValue<T>
+Represents a value which will expire in the future
+ |
+
class |
+SoftValue<T>
+Represents a value wrapped in a
+SoftReference |
+
class |
+WeakValue<T>
+Represents a value wrapped in a
+WeakReference |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> void |
+MetadataMap.forcePut(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> void |
+MetadataMap.put(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, removing any previous value if present.
+ |
+
<T> boolean |
+MetadataMap.putIfAbsent(MetadataKey<T> key,
+ TransientValue<T> value)
+Adds a metadata key and corresponding value into this map, only if an existing key is not present.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+MetadataMap.getOrPutExpiring(MetadataKey<T> key,
+ Supplier<TransientValue<T>> def)
+Gets a value for the given key, or puts and returns the default if one isn't present.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/class-use/WeakValue.html b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/WeakValue.html new file mode 100644 index 00000000..0de8d79e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/class-use/WeakValue.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static <T> WeakValue<T> |
+WeakValue.of(T value) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/package-frame.html b/docs/javadoc/helper/me/lucko/helper/metadata/package-frame.html new file mode 100644 index 00000000..9dfdcde2 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/package-frame.html @@ -0,0 +1,31 @@ + + + + + + +| Interface | +Description | +
|---|---|
| MetadataKey<T> | +
+ A MetadataKey can be mapped to values in a
+MetadataMap. |
+
| MetadataMap | +
+ A map which holds
+MetadataKeys, and maps them to persistent or transient (expiring / weak) values. |
+
| TransientValue<T> | +
+ Represents a value in a
+MetadataMap which will automatically expire at some point. |
+
| Class | +Description | +
|---|---|
| Empty | +
+ An object which represents nothing.
+ |
+
| ExpiringValue<T> | +
+ Represents a value which will expire in the future
+ |
+
| Metadata | +
+ Holds
+MetadataMaps bound to players, entities, blocks and worlds. |
+
| SoftValue<T> | +
+ Represents a value wrapped in a
+SoftReference |
+
| WeakValue<T> | +
+ Represents a value wrapped in a
+WeakReference |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/package-tree.html b/docs/javadoc/helper/me/lucko/helper/metadata/package-tree.html new file mode 100644 index 00000000..ecfaf750 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/metadata/package-use.html b/docs/javadoc/helper/me/lucko/helper/metadata/package-use.html new file mode 100644 index 00000000..4d830701 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/metadata/package-use.html @@ -0,0 +1,233 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.metadata | ++ |
| Class and Description | +
|---|
| MetadataKey
+ A MetadataKey can be mapped to values in a
+MetadataMap. |
+
| Class and Description | +
|---|
| MetadataKey
+ A MetadataKey can be mapped to values in a
+MetadataMap. |
+
| Class and Description | +
|---|
| Empty
+ An object which represents nothing.
+ |
+
| ExpiringValue
+ Represents a value which will expire in the future
+ |
+
| MetadataKey
+ A MetadataKey can be mapped to values in a
+MetadataMap. |
+
| MetadataMap
+ A map which holds
+MetadataKeys, and maps them to persistent or transient (expiring / weak) values. |
+
| SoftValue
+ Represents a value wrapped in a
+SoftReference |
+
| TransientValue
+ Represents a value in a
+MetadataMap which will automatically expire at some point. |
+
| WeakValue
+ Represents a value wrapped in a
+WeakReference |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/package-frame.html b/docs/javadoc/helper/me/lucko/helper/package-frame.html new file mode 100644 index 00000000..368e6f7e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/package-frame.html @@ -0,0 +1,37 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Commands.CommandBuilder<T extends CommandSender> | +
+ Builds a
+Commands.FunctionalCommand |
+
| Commands.CommandContext<T extends CommandSender> | +
+ Represents the context for a command call
+ |
+
| Commands.CommandHandler<T extends CommandSender> | +
+ Represents a handler for a
+Commands.FunctionalCommand |
+
| Commands.FunctionalCommand | +
+ Represents a command built from functional predicate calls
+ |
+
| Events.DefaultFilters | +
+ Provides a set of useful default filters for passing to
+Events.HandlerBuilder.filter(Predicate). |
+
| Events.Handler<T> | +
+ Responsible for the handling of a given event
+ |
+
| Events.HandlerBuilder<T extends Event> | +
+ Builds a
+Events.Handler |
+
| Events.MergedHandler<T> | +
+ Responsible for the handling of a merged event
+ |
+
| Events.MergedHandlerBuilder<T> | +
+ Builds a
+Events.MergedHandler |
+
| Scheduler.Task | +
+ Represents a scheduled repeating task
+ |
+
| Class | +Description | +
|---|---|
| Commands | +
+ A functional command handling utility.
+ |
+
| Events | +
+ A functional event listening utility.
+ |
+
| Helper | +
+ Base class for helper, which mainly just proxies calls to
+Bukkit.getServer() for convenience. |
+
| Scheduler | +
+ A utility class to help with scheduling.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/package-tree.html b/docs/javadoc/helper/me/lucko/helper/package-tree.html new file mode 100644 index 00000000..d5b6c324 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/package-tree.html @@ -0,0 +1,159 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/package-use.html b/docs/javadoc/helper/me/lucko/helper/package-use.html new file mode 100644 index 00000000..9f5beb48 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/package-use.html @@ -0,0 +1,206 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| Class and Description | +
|---|
| Commands.CommandBuilder
+ Builds a
+Commands.FunctionalCommand |
+
| Commands.CommandContext
+ Represents the context for a command call
+ |
+
| Commands.CommandHandler
+ Represents a handler for a
+Commands.FunctionalCommand |
+
| Commands.FunctionalCommand
+ Represents a command built from functional predicate calls
+ |
+
| Events.DefaultFilters
+ Provides a set of useful default filters for passing to
+Events.HandlerBuilder.filter(Predicate). |
+
| Events.Handler
+ Responsible for the handling of a given event
+ |
+
| Events.HandlerBuilder
+ Builds a
+Events.Handler |
+
| Events.MergedHandler
+ Responsible for the handling of a merged event
+ |
+
| Events.MergedHandlerBuilder
+ Builds a
+Events.MergedHandler |
+
| Scheduler.Task
+ Represents a scheduled repeating task
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/DummyHelperPlugin.html b/docs/javadoc/helper/me/lucko/helper/plugin/DummyHelperPlugin.html new file mode 100644 index 00000000..25d05c9c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/DummyHelperPlugin.html @@ -0,0 +1,319 @@ + + + + + + +public class DummyHelperPlugin +extends ExtendedJavaPlugin+
| Constructor and Description | +
|---|
DummyHelperPlugin() |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected void |
+enable() |
+
bind, bindComposite, bindRunnable, disable, getBundledFile, getPlugin, getService, load, loadConfig, onDisable, onEnable, onLoad, provideService, provideService, registerCommand, registerListenergetClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toStringequals, getName, hashCodeCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ExtendedJavaPlugin.html b/docs/javadoc/helper/me/lucko/helper/plugin/ExtendedJavaPlugin.html new file mode 100644 index 00000000..e62ad1b5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ExtendedJavaPlugin.html @@ -0,0 +1,721 @@ + + + + + + +public class ExtendedJavaPlugin +extends JavaPlugin +implements TerminableConsumer, CompositeTerminableConsumer+
| Constructor and Description | +
|---|
ExtendedJavaPlugin() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+bind(T terminable)
+Binds with the given terminable.
+ |
+
<T extends CompositeTerminable> |
+bindComposite(T terminable)
+Binds a composite terminable to this consumer
+ |
+
<T extends Runnable> |
+bindRunnable(T runnable)
+Binds with the given runnable.
+ |
+
protected void |
+disable() |
+
protected void |
+enable() |
+
File |
+getBundledFile(String name)
+Gets a bundled file from the plugins resource folder.
+ |
+
<T> T |
+getPlugin(String name,
+ Class<T> pluginClass)
+Gets a plugin instance for the given plugin name
+ |
+
<T> T |
+getService(Class<T> service)
+Gets a service provided by the ServiceManager
+ |
+
protected void |
+load() |
+
YamlConfiguration |
+loadConfig(String file)
+Loads a config file from a file name.
+ |
+
void |
+onDisable() |
+
void |
+onEnable() |
+
void |
+onLoad() |
+
<T> T |
+provideService(Class<T> clazz,
+ T instance)
+Provides a service to the ServiceManager, bound to this plugin at
+ServicePriority.Normal. |
+
<T> T |
+provideService(Class<T> clazz,
+ T instance,
+ ServicePriority priority)
+Provides a service to the ServiceManager, bound to this plugin
+ |
+
<T extends CommandExecutor> |
+registerCommand(T command,
+ String... aliases)
+Registers a CommandExecutor with the server
+ |
+
<T extends Listener> |
+registerListener(T listener)
+Register a listener with the server.
+ |
+
getClassLoader, getCommand, getConfig, getDataFolder, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable, toStringequals, getName, hashCodeprotected void load()+
protected void enable()+
protected void disable()+
public final void onLoad()+
onLoad in interface PluginonLoad in class JavaPluginpublic final void onEnable()+
onEnable in interface PluginonEnable in class JavaPluginpublic final void onDisable()+
onDisable in interface PluginonDisable in class JavaPlugin@Nonnull +public <T extends Terminable> T bind(@Nonnull + T terminable)+
TerminableConsumerbind in interface TerminableConsumerT - the terminable typeterminable - the terminable to bind with@Nonnull +public <T extends Runnable> T bindRunnable(@Nonnull + T runnable)+
TerminableConsumerbindRunnable in interface TerminableConsumerT - the terminable typerunnable - the runnable to bind with@Nonnull +public <T extends CompositeTerminable> T bindComposite(@Nonnull + T terminable)+
CompositeTerminableConsumerbindComposite in interface CompositeTerminableConsumerT - the terminable class typeterminable - the terminable to bind@Nonnull +public <T extends Listener> T registerListener(@Nonnull + T listener)+
Events should be used instead of this method in most cases.
T - the listener class typelistener - the listener to register@Nonnull +public <T extends CommandExecutor> T registerCommand(@Nonnull + T command, + @Nonnull + String... aliases)+
T - the command executor class typecommand - the command instancealiases - the command aliases@Nullable +public <T> T getService(@Nonnull + Class<T> service)+
T - the class typeservice - the service class@Nonnull +public <T> T provideService(@Nonnull + Class<T> clazz, + @Nonnull + T instance, + @Nonnull + ServicePriority priority)+
T - the service class typeclazz - the service classinstance - the instancepriority - the priority to register the service at@Nonnull +public <T> T provideService(@Nonnull + Class<T> clazz, + @Nonnull + T instance)+
ServicePriority.Normal.T - the service class typeclazz - the service classinstance - the instance@Nullable +public <T> T getPlugin(@Nonnull + String name, + @Nonnull + Class<T> pluginClass)+
T - the main class typename - the name of the pluginpluginClass - the main plugin class@Nonnull +public File getBundledFile(@Nonnull + String name)+
If the file is not present, a version of it it copied from the jar.
name - the name of the file@Nonnull +public YamlConfiguration loadConfig(@Nonnull + String file)+
Behaves in the same was as getBundledFile(String) when the file is not present.
file - the name of the fileCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/Plugin.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/Plugin.html new file mode 100644 index 00000000..8dc665de --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/Plugin.html @@ -0,0 +1,493 @@ + + + + + + +@Documented + @Target(value=TYPE) + @Retention(value=SOURCE) +public @interface Plugin+
| Modifier and Type | +Required Element and Description | +
|---|---|
String |
+name
+The name of the plugin
+ |
+
| Modifier and Type | +Optional Element and Description | +
|---|---|
String[] |
+authors
+The authors of the plugin
+ |
+
PluginDependency[] |
+depends
+A list of dependencies for the plugin
+ |
+
String |
+description
+A description of the plugin
+ |
+
String[] |
+hardDepends
+A list of hard dependencies for the plugin
+ |
+
PluginLoadOrder |
+load
+The load order of the plugin
+ |
+
String[] |
+loadBefore
+A list of plugins which should be loaded before this plugin
+ |
+
String[] |
+softDepends
+A list of soft dependencies for the plugin
+ |
+
String |
+version
+The plugin version
+ |
+
String |
+website
+A website for the plugin
+ |
+
@Nonnull +public abstract PluginLoadOrder load+
@Nonnull +public abstract PluginDependency[] depends+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/PluginDependency.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/PluginDependency.html new file mode 100644 index 00000000..dd01bdff --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/PluginDependency.html @@ -0,0 +1,265 @@ + + + + + + +public @interface PluginDependency
+Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/PluginProcessor.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/PluginProcessor.html new file mode 100644 index 00000000..1554524a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/PluginProcessor.html @@ -0,0 +1,315 @@ + + + + + + +@SupportedSourceVersion(value=RELEASE_8) + @SupportedAnnotationTypes(value={"me.lucko.helper.plugin.ap.Plugin","me.lucko.helper.plugin.ap.PluginDependency"}) +public class PluginProcessor +extends AbstractProcessor+
Plugin annotation and generates a plugin.yml file.processingEnv| Constructor and Description | +
|---|
PluginProcessor() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+process(Set<? extends TypeElement> annotations,
+ RoundEnvironment env) |
+
getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, init, isInitializedpublic boolean process(Set<? extends TypeElement> annotations, + RoundEnvironment env)+
process in interface Processorprocess in class AbstractProcessorCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/Plugin.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/Plugin.html new file mode 100644 index 00000000..d64c1ade --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/Plugin.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/PluginDependency.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/PluginDependency.html new file mode 100644 index 00000000..56ac9812 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/PluginDependency.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/PluginProcessor.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/PluginProcessor.html new file mode 100644 index 00000000..5fa6424b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/class-use/PluginProcessor.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-frame.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-frame.html new file mode 100644 index 00000000..6b53824b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Class | +Description | +
|---|---|
| PluginProcessor | +
+ Processes the
+Plugin annotation and generates a plugin.yml file. |
+
| Annotation Type | +Description | +
|---|---|
| Plugin | +
+ Annotation to automatically generate plugin.yml files for helper projects
+ |
+
| PluginDependency | +
+ Represents a plugin dependency
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-tree.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-tree.html new file mode 100644 index 00000000..6dc7bf6c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-tree.html @@ -0,0 +1,148 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-use.html b/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-use.html new file mode 100644 index 00000000..321723ed --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/ap/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/class-use/DummyHelperPlugin.html b/docs/javadoc/helper/me/lucko/helper/plugin/class-use/DummyHelperPlugin.html new file mode 100644 index 00000000..cfe49f3f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/class-use/DummyHelperPlugin.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/class-use/ExtendedJavaPlugin.html b/docs/javadoc/helper/me/lucko/helper/plugin/class-use/ExtendedJavaPlugin.html new file mode 100644 index 00000000..5cdd9129 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/class-use/ExtendedJavaPlugin.html @@ -0,0 +1,213 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Commands.FunctionalCommand.register(ExtendedJavaPlugin plugin,
+ String... aliases)
+Registers this command with the server, via the given plugin instance
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DummyHelperPlugin
+Dummy plugin to make the server load this lib.
+ |
+
| Constructor and Description | +
|---|
PacketScoreboard(ExtendedJavaPlugin plugin) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/package-frame.html b/docs/javadoc/helper/me/lucko/helper/plugin/package-frame.html new file mode 100644 index 00000000..23aa597b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Class | +Description | +
|---|---|
| DummyHelperPlugin | +
+ Dummy plugin to make the server load this lib.
+ |
+
| ExtendedJavaPlugin | +
+ An "extended" JavaPlugin class.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/package-tree.html b/docs/javadoc/helper/me/lucko/helper/plugin/package-tree.html new file mode 100644 index 00000000..da694f6d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/plugin/package-use.html b/docs/javadoc/helper/me/lucko/helper/plugin/package-use.html new file mode 100644 index 00000000..4c13973f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/plugin/package-use.html @@ -0,0 +1,203 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.scoreboard | ++ |
| Class and Description | +
|---|
| ExtendedJavaPlugin
+ An "extended" JavaPlugin class.
+ |
+
| Class and Description | +
|---|
| ExtendedJavaPlugin
+ An "extended" JavaPlugin class.
+ |
+
| Class and Description | +
|---|
| ExtendedJavaPlugin
+ An "extended" JavaPlugin class.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/GlobalScoreboard.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/GlobalScoreboard.html new file mode 100644 index 00000000..dbcd2fe9 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/GlobalScoreboard.html @@ -0,0 +1,249 @@ + + + + + + +public final class GlobalScoreboard +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static PacketScoreboard |
+get()
+Gets the global scoreboard
+ |
+
public static PacketScoreboard get()+
IllegalStateException - if ProtocolLib is not loadedCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboard.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboard.html new file mode 100644 index 00000000..9dc63685 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboard.html @@ -0,0 +1,726 @@ + + + + + + +@NonnullByDefault +public class PacketScoreboard +extends Object +implements Scoreboard+
| Constructor and Description | +
|---|
PacketScoreboard() |
+
PacketScoreboard(ExtendedJavaPlugin plugin) |
+
| Modifier and Type | +Method and Description | +
|---|---|
PacketScoreboardObjective |
+createObjective(String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective with an automatically generated id
+ |
+
PacketScoreboardObjective |
+createObjective(String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective
+ |
+
PacketScoreboardObjective |
+createPlayerObjective(Player player,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective with an automatically generated id
+ |
+
PacketScoreboardObjective |
+createPlayerObjective(Player player,
+ String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective
+ |
+
PacketScoreboardTeam |
+createPlayerTeam(Player player,
+ String title)
+Creates a new per-player scoreboard team with an automatically generated id
+ |
+
PacketScoreboardTeam |
+createPlayerTeam(Player player,
+ String id,
+ String title)
+Creates a new per-player scoreboard team
+ |
+
PacketScoreboardTeam |
+createTeam(String title)
+Creates a new scoreboard team with an automatically generated id
+ |
+
PacketScoreboardTeam |
+createTeam(String id,
+ String title)
+Creates a new scoreboard team
+ |
+
PacketScoreboardObjective |
+getObjective(String id)
+Gets an existing scoreboard objective if one with the id exists
+ |
+
PacketScoreboardObjective |
+getPlayerObjective(Player player,
+ String id)
+Gets an existing per-player scoreboard objective if one with the id exists
+ |
+
PacketScoreboardTeam |
+getPlayerTeam(Player player,
+ String id)
+Gets an existing per-player scoreboard team if one with the id exists
+ |
+
PacketScoreboardTeam |
+getTeam(String id)
+Gets an existing scoreboard team if one with the id exists
+ |
+
boolean |
+removeObjective(String id)
+Removes a scoreboard objective from this scoreboard
+ |
+
boolean |
+removePlayerObjective(Player player,
+ String id)
+Removes a per-player scoreboard objective from this scoreboard
+ |
+
boolean |
+removePlayerTeam(Player player,
+ String id)
+Removes a per-player scoreboard team from this scoreboard
+ |
+
boolean |
+removeTeam(String id)
+Removes a scoreboard team from this scoreboard
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetpublic PacketScoreboard()+
public PacketScoreboard(ExtendedJavaPlugin plugin)+
public PacketScoreboardTeam createTeam(String id, + String title)+
createTeam in interface Scoreboardid - the id of the teamtitle - the initial title for the teamIllegalStateException - if a team with the same id already existspublic PacketScoreboardTeam createTeam(String title)+
createTeam in interface Scoreboardtitle - the initial title for the teampublic PacketScoreboardTeam getTeam(String id)+
getTeam in interface Scoreboardid - the id of the teampublic boolean removeTeam(String id)+
removeTeam in interface Scoreboardid - the id of the teampublic PacketScoreboardObjective createObjective(String id, + String title, + DisplaySlot displaySlot)+
createObjective in interface Scoreboardid - the id of the objectivetitle - the initial title for the objectivedisplaySlot - the display slot to use for this objectiveIllegalStateException - if an objective with the same id already existspublic PacketScoreboardObjective createObjective(String title, + DisplaySlot displaySlot)+
createObjective in interface Scoreboardtitle - the initial title for the objectivedisplaySlot - the display slot to use for this objectivepublic PacketScoreboardObjective getObjective(String id)+
getObjective in interface Scoreboardid - the id of the objectivepublic boolean removeObjective(String id)+
removeObjective in interface Scoreboardid - the id of the objectivepublic PacketScoreboardTeam createPlayerTeam(Player player, + String id, + String title)+
createPlayerTeam in interface Scoreboardplayer - the player to make the team forid - the id of the teamtitle - the initial title of the teamIllegalStateException - if a team with the same id already existspublic PacketScoreboardTeam createPlayerTeam(Player player, + String title)+
createPlayerTeam in interface Scoreboardplayer - the player to make the team fortitle - the initial title of the teampublic PacketScoreboardTeam getPlayerTeam(Player player, + String id)+
getPlayerTeam in interface Scoreboardplayer - the player to get the team forid - the id of the teampublic boolean removePlayerTeam(Player player, + String id)+
removePlayerTeam in interface Scoreboardplayer - the player to remove the team forid - the id of the teampublic PacketScoreboardObjective createPlayerObjective(Player player, + String id, + String title, + DisplaySlot displaySlot)+
createPlayerObjective in interface Scoreboardplayer - the player to make the objective forid - the id of the objectivetitle - the initial title of the objectivedisplaySlot - the display slot to use for this objectiveIllegalStateException - if an objective with the same id already existspublic PacketScoreboardObjective createPlayerObjective(Player player, + String title, + DisplaySlot displaySlot)+
createPlayerObjective in interface Scoreboardplayer - the player to make the objective fortitle - the initial title of the objectivedisplaySlot - the display slot to use for this objectivepublic PacketScoreboardObjective getPlayerObjective(Player player, + String id)+
getPlayerObjective in interface Scoreboardplayer - the player to get the objective forid - the id of the objectivepublic boolean removePlayerObjective(Player player, + String id)+
removePlayerObjective in interface Scoreboardplayer - the player to remove the objective forid - the id of the objectiveCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboardObjective.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboardObjective.html new file mode 100644 index 00000000..712c3748 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboardObjective.html @@ -0,0 +1,710 @@ + + + + + + +@NonnullByDefault +public class PacketScoreboardObjective +extends Object +implements ScoreboardObjective+
http://wiki.vg/Protocol#Scoreboard_Objective
+http://wiki.vg/Protocol#Update_Score
+http://wiki.vg/Protocol#Display_Scoreboard
| Constructor and Description | +
|---|
PacketScoreboardObjective(PacketScoreboard scoreboard,
+ String id,
+ String displayName,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+applyLines(Collection<String> lines)
+Automatically applies a set of score lines to this objective.
+ |
+
void |
+applyLines(String... lines)
+Automatically applies a set of score lines to this objective.
+ |
+
void |
+applyScores(Map<String,Integer> scores)
+Applies a score mapping to this objective
+ |
+
void |
+clearScores()
+Clears the scores from this objective
+ |
+
String |
+getDisplayName()
+Gets the current display name of this objective
+ |
+
DisplaySlot |
+getDisplaySlot()
+Gets the current display slot of this objective
+ |
+
String |
+getId()
+Gets the id of this objective
+ |
+
Integer |
+getScore(String name)
+Gets the value mapped to a given score, if present
+ |
+
Map<String,Integer> |
+getScores()
+Gets an immutable copy of the current objective scores
+ |
+
boolean |
+hasScore(String name)
+Returns true if this objective has a given score
+ |
+
boolean |
+removeScore(String name)
+Removes a score
+ |
+
void |
+setDisplayName(String displayName)
+Lazily sets the display name to a new value and updates the objectives subscribers
+ |
+
void |
+setDisplaySlot(DisplaySlot displaySlot)
+Lazily sets the display slot to a new value and updates the objectives subscribers
+ |
+
void |
+setScore(String name,
+ int value)
+Sets a new score value
+ |
+
void |
+subscribe(Player player)
+Subscribes a player to this objective
+ |
+
void |
+unsubscribe(Player player)
+Unsubscribes a player from this objective
+ |
+
void |
+unsubscribe(Player player,
+ boolean fast)
+Unsubscribes a player from this objective
+ |
+
void |
+unsubscribeAll()
+Unsubscribes all players from this objective
+ |
+
public PacketScoreboardObjective(PacketScoreboard scoreboard, + String id, + String displayName, + DisplaySlot displaySlot)+
scoreboard - the parent scoreboardid - the id of this objectivedisplayName - the initial display namedisplaySlot - the initial display slotpublic String getId()+
ScoreboardObjectivegetId in interface ScoreboardObjectivepublic String getDisplayName()+
ScoreboardObjectivegetDisplayName in interface ScoreboardObjectivepublic void setDisplayName(String displayName)+
ScoreboardObjectivesetDisplayName in interface ScoreboardObjectivedisplayName - the new display namepublic DisplaySlot getDisplaySlot()+
ScoreboardObjectivegetDisplaySlot in interface ScoreboardObjectivepublic void setDisplaySlot(DisplaySlot displaySlot)+
ScoreboardObjectivesetDisplaySlot in interface ScoreboardObjectivedisplaySlot - the new display slotpublic Map<String,Integer> getScores()+
ScoreboardObjectivegetScores in interface ScoreboardObjectivepublic boolean hasScore(String name)+
ScoreboardObjectivehasScore in interface ScoreboardObjectivename - the name of the score to check for@Nullable +public Integer getScore(String name)+
ScoreboardObjectivegetScore in interface ScoreboardObjectivename - the name of the scorepublic void setScore(String name, + int value)+
ScoreboardObjectivesetScore in interface ScoreboardObjectivename - the name of the scorevalue - the value to set the score topublic boolean removeScore(String name)+
ScoreboardObjectiveremoveScore in interface ScoreboardObjectivename - the name of the scorepublic void clearScores()+
ScoreboardObjectiveclearScores in interface ScoreboardObjectivepublic void applyScores(Map<String,Integer> scores)+
ScoreboardObjectiveapplyScores in interface ScoreboardObjectivescores - the scores to applypublic void applyLines(String... lines)+
ScoreboardObjectiveapplyLines in interface ScoreboardObjectivelines - the lines to applypublic void applyLines(Collection<String> lines)+
ScoreboardObjectiveapplyLines in interface ScoreboardObjectivelines - the lines to applypublic void subscribe(Player player)+
ScoreboardObjectivesubscribe in interface ScoreboardObjectiveplayer - the player to subscribepublic void unsubscribe(Player player)+
ScoreboardObjectiveunsubscribe in interface ScoreboardObjectiveplayer - the player to unsubscribepublic void unsubscribe(Player player, + boolean fast)+
ScoreboardObjectiveunsubscribe in interface ScoreboardObjectiveplayer - the player to unsubscribefast - if true, the removal packet will not be sent (for use when the player is leaving)public void unsubscribeAll()+
ScoreboardObjectiveunsubscribeAll in interface ScoreboardObjectiveCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboardTeam.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboardTeam.html new file mode 100644 index 00000000..7cfcda06 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/PacketScoreboardTeam.html @@ -0,0 +1,833 @@ + + + + + + +@NonnullByDefault +public class PacketScoreboardTeam +extends Object +implements ScoreboardTeam+
ScoreboardTeam.CollisionRule, ScoreboardTeam.NameTagVisibility| Constructor and Description | +
|---|
PacketScoreboardTeam(PacketScoreboard scoreboard,
+ String id,
+ String displayName)
+Creates a new scoreboard team
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+addPlayer(Player player)
+Adds a player to this team
+ |
+
ScoreboardTeam.CollisionRule |
+getCollisionRule()
+Gets the current collision rule setting
+ |
+
String |
+getDisplayName()
+Gets the current display name of this team
+ |
+
String |
+getId()
+Gets the id of this team
+ |
+
ScoreboardTeam.NameTagVisibility |
+getNameTagVisibility()
+Gets the current nametag visibility setting
+ |
+
Set<Player> |
+getPlayers()
+Gets an immutable copy of the teams members
+ |
+
String |
+getPrefix()
+Gets the current prefix for this team
+ |
+
String |
+getSuffix()
+Gets the current suffix for this team
+ |
+
boolean |
+hasPlayer(Player player)
+Returns true if the given player is a member of this team
+ |
+
boolean |
+isAllowFriendlyFire()
+Gets if friendly fire is allowed
+ |
+
boolean |
+isCanSeeFriendlyInvisibles()
+Gets if members of this team can see invisible members on the same team
+ |
+
boolean |
+removePlayer(Player player)
+Removes a player from this team
+ |
+
void |
+setAllowFriendlyFire(boolean allowFriendlyFire)
+Lazily sets the friendly fire setting to new value and updates the teams subscribers
+ |
+
void |
+setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles)
+Lazily sets the friendly invisibility setting to new value and updates the teams subscribers
+ |
+
void |
+setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)
+Lazily sets the collision rule setting to new value and updates the teams subscribers
+ |
+
void |
+setDisplayName(String displayName)
+Lazily sets the display name to a new value and updates the teams subscribers
+ |
+
void |
+setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)
+Lazily sets the nametag visibility setting to new value and updates the teams subscribers
+ |
+
void |
+setPrefix(String prefix)
+Lazily sets the prefix to a new value and updates the teams subscribers
+ |
+
void |
+setSuffix(String suffix)
+Lazily sets the suffix to a new value and updates the teams subscribers
+ |
+
void |
+subscribe(Player player)
+Subscribes a player to this team
+ |
+
void |
+unsubscribe(Player player)
+Unsubscribes a player from this team
+ |
+
void |
+unsubscribe(Player player,
+ boolean fast)
+Unsubscribes a player from this team
+ |
+
void |
+unsubscribeAll()
+Unsubscribes all players from this team
+ |
+
public PacketScoreboardTeam(PacketScoreboard scoreboard, + String id, + String displayName)+
scoreboard - the parent scoreboardid - the id of this teamdisplayName - the initial display namepublic String getId()+
ScoreboardTeamgetId in interface ScoreboardTeampublic String getDisplayName()+
ScoreboardTeamgetDisplayName in interface ScoreboardTeampublic void setDisplayName(String displayName)+
ScoreboardTeamsetDisplayName in interface ScoreboardTeamdisplayName - the new display namepublic String getPrefix()+
ScoreboardTeamgetPrefix in interface ScoreboardTeampublic void setPrefix(String prefix)+
ScoreboardTeamsetPrefix in interface ScoreboardTeamprefix - the new prefixpublic String getSuffix()+
ScoreboardTeamgetSuffix in interface ScoreboardTeampublic void setSuffix(String suffix)+
ScoreboardTeamsetSuffix in interface ScoreboardTeamsuffix - the new suffixpublic boolean isAllowFriendlyFire()+
ScoreboardTeamisAllowFriendlyFire in interface ScoreboardTeampublic void setAllowFriendlyFire(boolean allowFriendlyFire)+
ScoreboardTeamsetAllowFriendlyFire in interface ScoreboardTeamallowFriendlyFire - the new settingpublic boolean isCanSeeFriendlyInvisibles()+
ScoreboardTeamisCanSeeFriendlyInvisibles in interface ScoreboardTeampublic void setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles)+
ScoreboardTeamsetCanSeeFriendlyInvisibles in interface ScoreboardTeamcanSeeFriendlyInvisibles - the new settingpublic ScoreboardTeam.NameTagVisibility getNameTagVisibility()+
ScoreboardTeamgetNameTagVisibility in interface ScoreboardTeampublic void setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)+
ScoreboardTeamsetNameTagVisibility in interface ScoreboardTeamnameTagVisibility - the new settingpublic ScoreboardTeam.CollisionRule getCollisionRule()+
ScoreboardTeamgetCollisionRule in interface ScoreboardTeampublic void setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)+
ScoreboardTeamsetCollisionRule in interface ScoreboardTeamcollisionRule - the new settingpublic boolean addPlayer(Player player)+
ScoreboardTeamaddPlayer in interface ScoreboardTeamplayer - the player to addpublic boolean removePlayer(Player player)+
ScoreboardTeamremovePlayer in interface ScoreboardTeamplayer - the player to removepublic boolean hasPlayer(Player player)+
ScoreboardTeamhasPlayer in interface ScoreboardTeamplayer - the player to check forpublic Set<Player> getPlayers()+
ScoreboardTeamgetPlayers in interface ScoreboardTeampublic void subscribe(Player player)+
ScoreboardTeamsubscribe in interface ScoreboardTeamplayer - the player to subscribepublic void unsubscribe(Player player)+
ScoreboardTeamunsubscribe in interface ScoreboardTeamplayer - the player to unsubscribepublic void unsubscribe(Player player, + boolean fast)+
ScoreboardTeamunsubscribe in interface ScoreboardTeamplayer - the player to unsubscribefast - if true, the removal packet will not be sent (for use when the player is leaving)public void unsubscribeAll()+
ScoreboardTeamunsubscribeAll in interface ScoreboardTeamCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/Scoreboard.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/Scoreboard.html new file mode 100644 index 00000000..e4bb22c9 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/Scoreboard.html @@ -0,0 +1,645 @@ + + + + + + +@NonnullByDefault +public interface Scoreboard+
| Modifier and Type | +Method and Description | +
|---|---|
ScoreboardObjective |
+createObjective(String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective with an automatically generated id
+ |
+
ScoreboardObjective |
+createObjective(String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective
+ |
+
ScoreboardObjective |
+createPlayerObjective(Player player,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective with an automatically generated id
+ |
+
ScoreboardObjective |
+createPlayerObjective(Player player,
+ String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective
+ |
+
ScoreboardTeam |
+createPlayerTeam(Player player,
+ String title)
+Creates a new per-player scoreboard team with an automatically generated id
+ |
+
ScoreboardTeam |
+createPlayerTeam(Player player,
+ String id,
+ String title)
+Creates a new per-player scoreboard team
+ |
+
ScoreboardTeam |
+createTeam(String title)
+Creates a new scoreboard team with an automatically generated id
+ |
+
ScoreboardTeam |
+createTeam(String id,
+ String title)
+Creates a new scoreboard team
+ |
+
static PacketScoreboard |
+get()
+Gets the global scoreboard instance.
+ |
+
ScoreboardObjective |
+getObjective(String id)
+Gets an existing scoreboard objective if one with the id exists
+ |
+
ScoreboardObjective |
+getPlayerObjective(Player player,
+ String id)
+Gets an existing per-player scoreboard objective if one with the id exists
+ |
+
ScoreboardTeam |
+getPlayerTeam(Player player,
+ String id)
+Gets an existing per-player scoreboard team if one with the id exists
+ |
+
ScoreboardTeam |
+getTeam(String id)
+Gets an existing scoreboard team if one with the id exists
+ |
+
boolean |
+removeObjective(String id)
+Removes a scoreboard objective from this scoreboard
+ |
+
boolean |
+removePlayerObjective(Player player,
+ String id)
+Removes a per-player scoreboard objective from this scoreboard
+ |
+
boolean |
+removePlayerTeam(Player player,
+ String id)
+Removes a per-player scoreboard team from this scoreboard
+ |
+
boolean |
+removeTeam(String id)
+Removes a scoreboard team from this scoreboard
+ |
+
@Nonnull +static PacketScoreboard get()+
ScoreboardTeam createTeam(String id, + String title)+
id - the id of the teamtitle - the initial title for the teamIllegalStateException - if a team with the same id already existsScoreboardTeam createTeam(String title)+
title - the initial title for the teamScoreboardTeam getTeam(String id)+
id - the id of the teamboolean removeTeam(String id)+
id - the id of the teamScoreboardObjective createObjective(String id, + String title, + DisplaySlot displaySlot)+
id - the id of the objectivetitle - the initial title for the objectivedisplaySlot - the display slot to use for this objectiveIllegalStateException - if an objective with the same id already existsScoreboardObjective createObjective(String title, + DisplaySlot displaySlot)+
title - the initial title for the objectivedisplaySlot - the display slot to use for this objectiveScoreboardObjective getObjective(String id)+
id - the id of the objectiveboolean removeObjective(String id)+
id - the id of the objectiveScoreboardTeam createPlayerTeam(Player player, + String id, + String title)+
player - the player to make the team forid - the id of the teamtitle - the initial title of the teamIllegalStateException - if a team with the same id already existsScoreboardTeam createPlayerTeam(Player player, + String title)+
player - the player to make the team fortitle - the initial title of the teamScoreboardTeam getPlayerTeam(Player player, + String id)+
player - the player to get the team forid - the id of the teamboolean removePlayerTeam(Player player, + String id)+
player - the player to remove the team forid - the id of the teamScoreboardObjective createPlayerObjective(Player player, + String id, + String title, + DisplaySlot displaySlot)+
player - the player to make the objective forid - the id of the objectivetitle - the initial title of the objectivedisplaySlot - the display slot to use for this objectiveIllegalStateException - if an objective with the same id already existsScoreboardObjective createPlayerObjective(Player player, + String title, + DisplaySlot displaySlot)+
player - the player to make the objective fortitle - the initial title of the objectivedisplaySlot - the display slot to use for this objectiveScoreboardObjective getPlayerObjective(Player player, + String id)+
player - the player to get the objective forid - the id of the objectiveboolean removePlayerObjective(Player player, + String id)+
player - the player to remove the objective forid - the id of the objectiveCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardObjective.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardObjective.html new file mode 100644 index 00000000..ee264c33 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardObjective.html @@ -0,0 +1,581 @@ + + + + + + +@NonnullByDefault +public interface ScoreboardObjective+
Scoreboard.| Modifier and Type | +Method and Description | +
|---|---|
void |
+applyLines(Collection<String> lines)
+Automatically applies a set of score lines to this objective.
+ |
+
void |
+applyLines(String... lines)
+Automatically applies a set of score lines to this objective.
+ |
+
void |
+applyScores(Map<String,Integer> scores)
+Applies a score mapping to this objective
+ |
+
void |
+clearScores()
+Clears the scores from this objective
+ |
+
String |
+getDisplayName()
+Gets the current display name of this objective
+ |
+
DisplaySlot |
+getDisplaySlot()
+Gets the current display slot of this objective
+ |
+
String |
+getId()
+Gets the id of this objective
+ |
+
Integer |
+getScore(String name)
+Gets the value mapped to a given score, if present
+ |
+
Map<String,Integer> |
+getScores()
+Gets an immutable copy of the current objective scores
+ |
+
boolean |
+hasScore(String name)
+Returns true if this objective has a given score
+ |
+
boolean |
+removeScore(String name)
+Removes a score
+ |
+
void |
+setDisplayName(String displayName)
+Lazily sets the display name to a new value and updates the objectives subscribers
+ |
+
void |
+setDisplaySlot(DisplaySlot displaySlot)
+Lazily sets the display slot to a new value and updates the objectives subscribers
+ |
+
void |
+setScore(String name,
+ int value)
+Sets a new score value
+ |
+
void |
+subscribe(Player player)
+Subscribes a player to this objective
+ |
+
void |
+unsubscribe(Player player)
+Unsubscribes a player from this objective
+ |
+
void |
+unsubscribe(Player player,
+ boolean fast)
+Unsubscribes a player from this objective
+ |
+
void |
+unsubscribeAll()
+Unsubscribes all players from this objective
+ |
+
String getId()+
String getDisplayName()+
void setDisplayName(String displayName)+
displayName - the new display nameDisplaySlot getDisplaySlot()+
void setDisplaySlot(DisplaySlot displaySlot)+
displaySlot - the new display slotMap<String,Integer> getScores()+
boolean hasScore(String name)+
name - the name of the score to check for@Nullable +Integer getScore(String name)+
name - the name of the scorevoid setScore(String name, + int value)+
name - the name of the scorevalue - the value to set the score toboolean removeScore(String name)+
name - the name of the scorevoid clearScores()+
void applyScores(Map<String,Integer> scores)+
scores - the scores to applyvoid applyLines(String... lines)+
lines - the lines to applyvoid applyLines(Collection<String> lines)+
lines - the lines to applyvoid subscribe(Player player)+
player - the player to subscribevoid unsubscribe(Player player)+
player - the player to unsubscribevoid unsubscribe(Player player, + boolean fast)+
player - the player to unsubscribefast - if true, the removal packet will not be sent (for use when the player is leaving)void unsubscribeAll()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.CollisionRule.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.CollisionRule.html new file mode 100644 index 00000000..5697f08b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.CollisionRule.html @@ -0,0 +1,384 @@ + + + + + + +public static enum ScoreboardTeam.CollisionRule +extends Enum<ScoreboardTeam.CollisionRule>+
| Enum Constant and Description | +
|---|
ALWAYS |
+
HIDE_FOR_OTHER_TEAMS |
+
HIDE_FOR_OWN_TEAM |
+
NEVER |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getProtocolName() |
+
static ScoreboardTeam.CollisionRule |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ScoreboardTeam.CollisionRule[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ScoreboardTeam.CollisionRule ALWAYS+
public static final ScoreboardTeam.CollisionRule NEVER+
public static final ScoreboardTeam.CollisionRule HIDE_FOR_OTHER_TEAMS+
public static final ScoreboardTeam.CollisionRule HIDE_FOR_OWN_TEAM+
public static ScoreboardTeam.CollisionRule[] values()+
+for (ScoreboardTeam.CollisionRule c : ScoreboardTeam.CollisionRule.values()) + System.out.println(c); +
public static ScoreboardTeam.CollisionRule valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getProtocolName()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.NameTagVisibility.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.NameTagVisibility.html new file mode 100644 index 00000000..559a7774 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.NameTagVisibility.html @@ -0,0 +1,384 @@ + + + + + + +public static enum ScoreboardTeam.NameTagVisibility +extends Enum<ScoreboardTeam.NameTagVisibility>+
| Enum Constant and Description | +
|---|
ALWAYS |
+
HIDE_FOR_OTHER_TEAMS |
+
HIDE_FOR_OWN_TEAM |
+
NEVER |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getProtocolName() |
+
static ScoreboardTeam.NameTagVisibility |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ScoreboardTeam.NameTagVisibility[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final ScoreboardTeam.NameTagVisibility ALWAYS+
public static final ScoreboardTeam.NameTagVisibility NEVER+
public static final ScoreboardTeam.NameTagVisibility HIDE_FOR_OTHER_TEAMS+
public static final ScoreboardTeam.NameTagVisibility HIDE_FOR_OWN_TEAM+
public static ScoreboardTeam.NameTagVisibility[] values()+
+for (ScoreboardTeam.NameTagVisibility c : ScoreboardTeam.NameTagVisibility.values()) + System.out.println(c); +
public static ScoreboardTeam.NameTagVisibility valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic String getProtocolName()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.html new file mode 100644 index 00000000..9782efe8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/ScoreboardTeam.html @@ -0,0 +1,704 @@ + + + + + + +@NonnullByDefault +public interface ScoreboardTeam+
Scoreboard.| Modifier and Type | +Interface and Description | +
|---|---|
static class |
+ScoreboardTeam.CollisionRule |
+
static class |
+ScoreboardTeam.NameTagVisibility |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+addPlayer(Player player)
+Adds a player to this team
+ |
+
ScoreboardTeam.CollisionRule |
+getCollisionRule()
+Gets the current collision rule setting
+ |
+
String |
+getDisplayName()
+Gets the current display name of this team
+ |
+
String |
+getId()
+Gets the id of this team
+ |
+
ScoreboardTeam.NameTagVisibility |
+getNameTagVisibility()
+Gets the current nametag visibility setting
+ |
+
Set<Player> |
+getPlayers()
+Gets an immutable copy of the teams members
+ |
+
String |
+getPrefix()
+Gets the current prefix for this team
+ |
+
String |
+getSuffix()
+Gets the current suffix for this team
+ |
+
boolean |
+hasPlayer(Player player)
+Returns true if the given player is a member of this team
+ |
+
boolean |
+isAllowFriendlyFire()
+Gets if friendly fire is allowed
+ |
+
boolean |
+isCanSeeFriendlyInvisibles()
+Gets if members of this team can see invisible members on the same team
+ |
+
boolean |
+removePlayer(Player player)
+Removes a player from this team
+ |
+
void |
+setAllowFriendlyFire(boolean allowFriendlyFire)
+Lazily sets the friendly fire setting to new value and updates the teams subscribers
+ |
+
void |
+setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles)
+Lazily sets the friendly invisibility setting to new value and updates the teams subscribers
+ |
+
void |
+setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)
+Lazily sets the collision rule setting to new value and updates the teams subscribers
+ |
+
void |
+setDisplayName(String displayName)
+Lazily sets the display name to a new value and updates the teams subscribers
+ |
+
void |
+setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)
+Lazily sets the nametag visibility setting to new value and updates the teams subscribers
+ |
+
void |
+setPrefix(String prefix)
+Lazily sets the prefix to a new value and updates the teams subscribers
+ |
+
void |
+setSuffix(String suffix)
+Lazily sets the suffix to a new value and updates the teams subscribers
+ |
+
void |
+subscribe(Player player)
+Subscribes a player to this team
+ |
+
void |
+unsubscribe(Player player)
+Unsubscribes a player from this team
+ |
+
void |
+unsubscribe(Player player,
+ boolean fast)
+Unsubscribes a player from this team
+ |
+
void |
+unsubscribeAll()
+Unsubscribes all players from this team
+ |
+
String getId()+
String getDisplayName()+
void setDisplayName(String displayName)+
displayName - the new display nameString getPrefix()+
void setPrefix(String prefix)+
prefix - the new prefixString getSuffix()+
void setSuffix(String suffix)+
suffix - the new suffixboolean isAllowFriendlyFire()+
void setAllowFriendlyFire(boolean allowFriendlyFire)+
allowFriendlyFire - the new settingboolean isCanSeeFriendlyInvisibles()+
void setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles)+
canSeeFriendlyInvisibles - the new settingScoreboardTeam.NameTagVisibility getNameTagVisibility()+
void setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)+
nameTagVisibility - the new settingScoreboardTeam.CollisionRule getCollisionRule()+
void setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)+
collisionRule - the new settingboolean addPlayer(Player player)+
player - the player to addboolean removePlayer(Player player)+
player - the player to removeboolean hasPlayer(Player player)+
player - the player to check forSet<Player> getPlayers()+
void subscribe(Player player)+
player - the player to subscribevoid unsubscribe(Player player)+
player - the player to unsubscribevoid unsubscribe(Player player, + boolean fast)+
player - the player to unsubscribefast - if true, the removal packet will not be sent (for use when the player is leaving)void unsubscribeAll()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/GlobalScoreboard.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/GlobalScoreboard.html new file mode 100644 index 00000000..03c4c49b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/GlobalScoreboard.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboard.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboard.html new file mode 100644 index 00000000..87ca77ba --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboard.html @@ -0,0 +1,197 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static PacketScoreboard |
+Scoreboard.get()
+Gets the global scoreboard instance.
+ |
+
static PacketScoreboard |
+GlobalScoreboard.get()
+Gets the global scoreboard
+ |
+
| Constructor and Description | +
|---|
PacketScoreboardObjective(PacketScoreboard scoreboard,
+ String id,
+ String displayName,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective
+ |
+
PacketScoreboardTeam(PacketScoreboard scoreboard,
+ String id,
+ String displayName)
+Creates a new scoreboard team
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboardObjective.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboardObjective.html new file mode 100644 index 00000000..2620253b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboardObjective.html @@ -0,0 +1,207 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PacketScoreboardObjective |
+PacketScoreboard.createObjective(String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective with an automatically generated id
+ |
+
PacketScoreboardObjective |
+PacketScoreboard.createObjective(String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective
+ |
+
PacketScoreboardObjective |
+PacketScoreboard.createPlayerObjective(Player player,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective with an automatically generated id
+ |
+
PacketScoreboardObjective |
+PacketScoreboard.createPlayerObjective(Player player,
+ String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective
+ |
+
PacketScoreboardObjective |
+PacketScoreboard.getObjective(String id)
+Gets an existing scoreboard objective if one with the id exists
+ |
+
PacketScoreboardObjective |
+PacketScoreboard.getPlayerObjective(Player player,
+ String id)
+Gets an existing per-player scoreboard objective if one with the id exists
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboardTeam.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboardTeam.html new file mode 100644 index 00000000..e74018fb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/PacketScoreboardTeam.html @@ -0,0 +1,203 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PacketScoreboardTeam |
+PacketScoreboard.createPlayerTeam(Player player,
+ String title)
+Creates a new per-player scoreboard team with an automatically generated id
+ |
+
PacketScoreboardTeam |
+PacketScoreboard.createPlayerTeam(Player player,
+ String id,
+ String title)
+Creates a new per-player scoreboard team
+ |
+
PacketScoreboardTeam |
+PacketScoreboard.createTeam(String title)
+Creates a new scoreboard team with an automatically generated id
+ |
+
PacketScoreboardTeam |
+PacketScoreboard.createTeam(String id,
+ String title)
+Creates a new scoreboard team
+ |
+
PacketScoreboardTeam |
+PacketScoreboard.getPlayerTeam(Player player,
+ String id)
+Gets an existing per-player scoreboard team if one with the id exists
+ |
+
PacketScoreboardTeam |
+PacketScoreboard.getTeam(String id)
+Gets an existing scoreboard team if one with the id exists
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/Scoreboard.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/Scoreboard.html new file mode 100644 index 00000000..b603ade8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/Scoreboard.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PacketScoreboard
+A thread-safe scoreboard using ProtocolLib
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardObjective.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardObjective.html new file mode 100644 index 00000000..7eb6977a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardObjective.html @@ -0,0 +1,222 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PacketScoreboardObjective
+Wrapper for PacketPlayOutScoreboardObjective, PacketPlayOutScoreboardScore and PacketPlayOutScoreboardDisplayObjective
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ScoreboardObjective |
+Scoreboard.createObjective(String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective with an automatically generated id
+ |
+
ScoreboardObjective |
+Scoreboard.createObjective(String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new scoreboard objective
+ |
+
ScoreboardObjective |
+Scoreboard.createPlayerObjective(Player player,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective with an automatically generated id
+ |
+
ScoreboardObjective |
+Scoreboard.createPlayerObjective(Player player,
+ String id,
+ String title,
+ DisplaySlot displaySlot)
+Creates a new per-player scoreboard objective
+ |
+
ScoreboardObjective |
+Scoreboard.getObjective(String id)
+Gets an existing scoreboard objective if one with the id exists
+ |
+
ScoreboardObjective |
+Scoreboard.getPlayerObjective(Player player,
+ String id)
+Gets an existing per-player scoreboard objective if one with the id exists
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.CollisionRule.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.CollisionRule.html new file mode 100644 index 00000000..23f9450c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.CollisionRule.html @@ -0,0 +1,204 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ScoreboardTeam.CollisionRule |
+ScoreboardTeam.getCollisionRule()
+Gets the current collision rule setting
+ |
+
ScoreboardTeam.CollisionRule |
+PacketScoreboardTeam.getCollisionRule() |
+
static ScoreboardTeam.CollisionRule |
+ScoreboardTeam.CollisionRule.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ScoreboardTeam.CollisionRule[] |
+ScoreboardTeam.CollisionRule.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ScoreboardTeam.setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)
+Lazily sets the collision rule setting to new value and updates the teams subscribers
+ |
+
void |
+PacketScoreboardTeam.setCollisionRule(ScoreboardTeam.CollisionRule collisionRule) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.NameTagVisibility.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.NameTagVisibility.html new file mode 100644 index 00000000..b9cf5c0f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.NameTagVisibility.html @@ -0,0 +1,204 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ScoreboardTeam.NameTagVisibility |
+ScoreboardTeam.getNameTagVisibility()
+Gets the current nametag visibility setting
+ |
+
ScoreboardTeam.NameTagVisibility |
+PacketScoreboardTeam.getNameTagVisibility() |
+
static ScoreboardTeam.NameTagVisibility |
+ScoreboardTeam.NameTagVisibility.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static ScoreboardTeam.NameTagVisibility[] |
+ScoreboardTeam.NameTagVisibility.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+ScoreboardTeam.setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)
+Lazily sets the nametag visibility setting to new value and updates the teams subscribers
+ |
+
void |
+PacketScoreboardTeam.setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.html new file mode 100644 index 00000000..501b24dc --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/class-use/ScoreboardTeam.html @@ -0,0 +1,220 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PacketScoreboardTeam
+Packet wrapper for PacketPlayOutScoreboardTeam
+
+ http://wiki.vg/Protocol#Teams
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
ScoreboardTeam |
+Scoreboard.createPlayerTeam(Player player,
+ String title)
+Creates a new per-player scoreboard team with an automatically generated id
+ |
+
ScoreboardTeam |
+Scoreboard.createPlayerTeam(Player player,
+ String id,
+ String title)
+Creates a new per-player scoreboard team
+ |
+
ScoreboardTeam |
+Scoreboard.createTeam(String title)
+Creates a new scoreboard team with an automatically generated id
+ |
+
ScoreboardTeam |
+Scoreboard.createTeam(String id,
+ String title)
+Creates a new scoreboard team
+ |
+
ScoreboardTeam |
+Scoreboard.getPlayerTeam(Player player,
+ String id)
+Gets an existing per-player scoreboard team if one with the id exists
+ |
+
ScoreboardTeam |
+Scoreboard.getTeam(String id)
+Gets an existing scoreboard team if one with the id exists
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/package-frame.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/package-frame.html new file mode 100644 index 00000000..f94b2072 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/package-frame.html @@ -0,0 +1,35 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Scoreboard | +
+ Represents a Scoreboard on the server
+ |
+
| ScoreboardObjective | +
+ Represents a specific objective on a
+Scoreboard. |
+
| ScoreboardTeam | +
+ Represents a specific team on a
+Scoreboard. |
+
| Class | +Description | +
|---|---|
| GlobalScoreboard | +
+ Contains a "global" scoreboard instance, lazily loaded on first request.
+ |
+
| PacketScoreboard | +
+ A thread-safe scoreboard using ProtocolLib
+ |
+
| PacketScoreboardObjective | +
+ Wrapper for PacketPlayOutScoreboardObjective, PacketPlayOutScoreboardScore and PacketPlayOutScoreboardDisplayObjective
+ |
+
| PacketScoreboardTeam | +
+ Packet wrapper for PacketPlayOutScoreboardTeam
+
+ http://wiki.vg/Protocol#Teams
+ |
+
| Enum | +Description | +
|---|---|
| ScoreboardTeam.CollisionRule | ++ |
| ScoreboardTeam.NameTagVisibility | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/package-tree.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/package-tree.html new file mode 100644 index 00000000..31296baa --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/scoreboard/package-use.html b/docs/javadoc/helper/me/lucko/helper/scoreboard/package-use.html new file mode 100644 index 00000000..f2284d5f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/scoreboard/package-use.html @@ -0,0 +1,194 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.scoreboard | ++ |
| Class and Description | +
|---|
| PacketScoreboard
+ A thread-safe scoreboard using ProtocolLib
+ |
+
| PacketScoreboardObjective
+ Wrapper for PacketPlayOutScoreboardObjective, PacketPlayOutScoreboardScore and PacketPlayOutScoreboardDisplayObjective
+ |
+
| PacketScoreboardTeam
+ Packet wrapper for PacketPlayOutScoreboardTeam
+
+ http://wiki.vg/Protocol#Teams
+ |
+
| Scoreboard
+ Represents a Scoreboard on the server
+ |
+
| ScoreboardObjective
+ Represents a specific objective on a
+Scoreboard. |
+
| ScoreboardTeam
+ Represents a specific team on a
+Scoreboard. |
+
| ScoreboardTeam.CollisionRule | +
| ScoreboardTeam.NameTagVisibility | +
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/BlockPosition.html b/docs/javadoc/helper/me/lucko/helper/serialize/BlockPosition.html new file mode 100644 index 00000000..41902d57 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/BlockPosition.html @@ -0,0 +1,652 @@ + + + + + + +public final class BlockPosition +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
BlockPosition |
+add(int x,
+ int y,
+ int z) |
+
BlockPosition |
+add(Vector3i vector3i) |
+
static BlockPosition |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
BlockPosition |
+getRelative(BlockFace face) |
+
BlockPosition |
+getRelative(BlockFace face,
+ int distance) |
+
String |
+getWorld() |
+
int |
+getX() |
+
int |
+getY() |
+
int |
+getZ() |
+
int |
+hashCode() |
+
static BlockPosition |
+of(Block block) |
+
static BlockPosition |
+of(int x,
+ int y,
+ int z,
+ String world) |
+
static BlockPosition |
+of(int x,
+ int y,
+ int z,
+ World world) |
+
static BlockPosition |
+of(Location location) |
+
static BlockPosition |
+of(Vector3i vector,
+ String world) |
+
static BlockPosition |
+of(Vector3i vector,
+ World world) |
+
BlockRegion |
+regionWith(BlockPosition other) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
BlockPosition |
+subtract(int x,
+ int y,
+ int z) |
+
BlockPosition |
+subtract(Vector3i vector3i) |
+
Block |
+toBlock() |
+
ChunkPosition |
+toChunk() |
+
Location |
+toLocation() |
+
Position |
+toPosition() |
+
Position |
+toPositionCenter() |
+
String |
+toString() |
+
Vector3i |
+toVector() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static BlockPosition deserialize(JsonElement element)+
public static BlockPosition of(int x, + int y, + int z, + String world)+
public static BlockPosition of(int x, + int y, + int z, + World world)+
public static BlockPosition of(Vector3i vector, + String world)+
public static BlockPosition of(Vector3i vector, + World world)+
public static BlockPosition of(Location location)+
public static BlockPosition of(Block block)+
public int getX()+
public int getY()+
public int getZ()+
public String getWorld()+
public Location toLocation()+
public Vector3i toVector()+
public Block toBlock()+
public Position toPosition()+
public Position toPositionCenter()+
public ChunkPosition toChunk()+
public BlockPosition getRelative(BlockFace face)+
public BlockPosition getRelative(BlockFace face, + int distance)+
public BlockPosition add(Vector3i vector3i)+
public BlockPosition add(int x, + int y, + int z)+
public BlockPosition subtract(Vector3i vector3i)+
public BlockPosition subtract(int x, + int y, + int z)+
public BlockRegion regionWith(BlockPosition other)+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/BlockRegion.html b/docs/javadoc/helper/me/lucko/helper/serialize/BlockRegion.html new file mode 100644 index 00000000..a12e12c9 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/BlockRegion.html @@ -0,0 +1,450 @@ + + + + + + +public final class BlockRegion +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
static BlockRegion |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
int |
+getDepth() |
+
int |
+getHeight() |
+
BlockPosition |
+getMax() |
+
BlockPosition |
+getMin() |
+
int |
+getWidth() |
+
int |
+hashCode() |
+
boolean |
+inRegion(Block block) |
+
boolean |
+inRegion(BlockPosition pos) |
+
boolean |
+inRegion(int x,
+ int y,
+ int z) |
+
static BlockRegion |
+of(BlockPosition a,
+ BlockPosition b) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static BlockRegion deserialize(JsonElement element)+
public static BlockRegion of(BlockPosition a, + BlockPosition b)+
public boolean inRegion(BlockPosition pos)+
public boolean inRegion(Block block)+
public boolean inRegion(int x, + int y, + int z)+
public BlockPosition getMin()+
public BlockPosition getMax()+
public int getWidth()+
public int getHeight()+
public int getDepth()+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/ChunkPosition.html b/docs/javadoc/helper/me/lucko/helper/serialize/ChunkPosition.html new file mode 100644 index 00000000..8bf577ca --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/ChunkPosition.html @@ -0,0 +1,570 @@ + + + + + + +public final class ChunkPosition +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
ChunkPosition |
+add(int x,
+ int z) |
+
ChunkPosition |
+add(Vector2i vector2i) |
+
static ChunkPosition |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
BlockPosition |
+getBlock(int x,
+ int y,
+ int z) |
+
ChunkPosition |
+getRelative(BlockFace face) |
+
ChunkPosition |
+getRelative(BlockFace face,
+ int distance) |
+
String |
+getWorld() |
+
int |
+getX() |
+
int |
+getZ() |
+
int |
+hashCode() |
+
static ChunkPosition |
+of(Chunk location) |
+
static ChunkPosition |
+of(int x,
+ int z,
+ String world) |
+
static ChunkPosition |
+of(int x,
+ int z,
+ World world) |
+
static ChunkPosition |
+of(Vector2i vector,
+ String world) |
+
static ChunkPosition |
+of(Vector2i vector,
+ World world) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
ChunkPosition |
+subtract(int x,
+ int z) |
+
ChunkPosition |
+subtract(Vector2i vector2i) |
+
Chunk |
+toChunk() |
+
String |
+toString() |
+
Vector2i |
+toVector() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static ChunkPosition deserialize(JsonElement element)+
public static ChunkPosition of(int x, + int z, + String world)+
public static ChunkPosition of(int x, + int z, + World world)+
public static ChunkPosition of(Vector2i vector, + String world)+
public static ChunkPosition of(Vector2i vector, + World world)+
public static ChunkPosition of(Chunk location)+
public int getX()+
public int getZ()+
public String getWorld()+
public Vector2i toVector()+
public Chunk toChunk()+
public BlockPosition getBlock(int x, + int y, + int z)+
public ChunkPosition getRelative(BlockFace face)+
public ChunkPosition getRelative(BlockFace face, + int distance)+
public ChunkPosition add(Vector2i vector2i)+
public ChunkPosition add(int x, + int z)+
public ChunkPosition subtract(Vector2i vector2i)+
public ChunkPosition subtract(int x, + int z)+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/ChunkRegion.html b/docs/javadoc/helper/me/lucko/helper/serialize/ChunkRegion.html new file mode 100644 index 00000000..d545783b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/ChunkRegion.html @@ -0,0 +1,422 @@ + + + + + + +public final class ChunkRegion +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
static ChunkRegion |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
int |
+getDepth() |
+
ChunkPosition |
+getMax() |
+
ChunkPosition |
+getMin() |
+
int |
+getWidth() |
+
int |
+hashCode() |
+
boolean |
+inRegion(ChunkPosition pos) |
+
boolean |
+inRegion(int x,
+ int z) |
+
static ChunkRegion |
+of(ChunkPosition a,
+ ChunkPosition b) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static ChunkRegion deserialize(JsonElement element)+
public static ChunkRegion of(ChunkPosition a, + ChunkPosition b)+
public boolean inRegion(ChunkPosition pos)+
public boolean inRegion(int x, + int z)+
public ChunkPosition getMin()+
public ChunkPosition getMax()+
public int getWidth()+
public int getDepth()+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/Direction.html b/docs/javadoc/helper/me/lucko/helper/serialize/Direction.html new file mode 100644 index 00000000..ed3433a6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/Direction.html @@ -0,0 +1,417 @@ + + + + + + +public final class Direction +extends Object +implements GsonSerializable+
| Modifier and Type | +Field and Description | +
|---|---|
static Direction |
+ZERO |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Direction |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
static Direction |
+from(Location location) |
+
float |
+getPitch() |
+
float |
+getYaw() |
+
int |
+hashCode() |
+
static Direction |
+of(float yaw,
+ float pitch) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static Direction deserialize(JsonElement element)+
public static Direction of(float yaw, + float pitch)+
public float getYaw()+
public float getPitch()+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/FileStorageHandler.html b/docs/javadoc/helper/me/lucko/helper/serialize/FileStorageHandler.html new file mode 100644 index 00000000..fa45e32c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/FileStorageHandler.html @@ -0,0 +1,368 @@ + + + + + + +T - the type being storedpublic abstract class FileStorageHandler<T> +extends Object+
| Constructor and Description | +
|---|
FileStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static <T> FileStorageHandler<T> |
+build(String fileName,
+ String fileExtension,
+ File dataFolder,
+ Function<Path,T> loadingFunc,
+ BiConsumer<Path,T> savingFunc) |
+
Optional<T> |
+load() |
+
protected abstract T |
+readFromFile(Path path) |
+
void |
+save(T data) |
+
void |
+saveAndBackup(T data) |
+
protected abstract void |
+saveToFile(Path path,
+ T t) |
+
public static <T> FileStorageHandler<T> build(String fileName, + String fileExtension, + File dataFolder, + Function<Path,T> loadingFunc, + BiConsumer<Path,T> savingFunc)+
public void saveAndBackup(T data)+
public void save(T data)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/GsonStorageHandler.html b/docs/javadoc/helper/me/lucko/helper/serialize/GsonStorageHandler.html new file mode 100644 index 00000000..0c8f7912 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/GsonStorageHandler.html @@ -0,0 +1,466 @@ + + + + + + +T - the type being storedpublic class GsonStorageHandler<T> +extends FileStorageHandler<T>+
FileStorageHandler implemented using Gson.| Modifier and Type | +Field and Description | +
|---|---|
protected Gson |
+gson |
+
protected Type |
+type |
+
| Constructor and Description | +
|---|
GsonStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder,
+ Class<T> clazz) |
+
GsonStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder,
+ Class<T> clazz,
+ Gson gson) |
+
GsonStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder,
+ Type type) |
+
GsonStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder,
+ Type type,
+ Gson gson) |
+
GsonStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder,
+ TypeToken<T> type) |
+
GsonStorageHandler(String fileName,
+ String fileExtension,
+ File dataFolder,
+ TypeToken<T> type,
+ Gson gson) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected T |
+readFromFile(Path path) |
+
protected void |
+saveToFile(Path path,
+ T t) |
+
build, load, save, saveAndBackupprotected final Type type+
protected final Gson gson+
public GsonStorageHandler(String fileName, + String fileExtension, + File dataFolder, + Class<T> clazz)+
public GsonStorageHandler(String fileName, + String fileExtension, + File dataFolder, + Class<T> clazz, + Gson gson)+
public GsonStorageHandler(String fileName, + String fileExtension, + File dataFolder, + TypeToken<T> type)+
public GsonStorageHandler(String fileName, + String fileExtension, + File dataFolder, + TypeToken<T> type, + Gson gson)+
public GsonStorageHandler(String fileName, + String fileExtension, + File dataFolder, + Type type)+
protected T readFromFile(Path path)+
readFromFile in class FileStorageHandler<T>protected void saveToFile(Path path, + T t)+
saveToFile in class FileStorageHandler<T>Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/Point.html b/docs/javadoc/helper/me/lucko/helper/serialize/Point.html new file mode 100644 index 00000000..0876d15f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/Point.html @@ -0,0 +1,428 @@ + + + + + + +public final class Point +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
Point |
+add(double x,
+ double y,
+ double z) |
+
static Point |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
Direction |
+getDirection() |
+
Position |
+getPosition() |
+
int |
+hashCode() |
+
static Point |
+of(Location location) |
+
static Point |
+of(Position position,
+ Direction direction) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
Point |
+subtract(double x,
+ double y,
+ double z) |
+
Location |
+toLocation() |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static Point deserialize(JsonElement element)+
public Position getPosition()+
public Direction getDirection()+
public Location toLocation()+
public Point add(double x, + double y, + double z)+
public Point subtract(double x, + double y, + double z)+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/Position.html b/docs/javadoc/helper/me/lucko/helper/serialize/Position.html new file mode 100644 index 00000000..ac7c9183 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/Position.html @@ -0,0 +1,652 @@ + + + + + + +public final class Position +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
Position |
+add(double x,
+ double y,
+ double z) |
+
Position |
+add(Vector3d vector3d) |
+
Position |
+add(Vector3i vector3i) |
+
static Position |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
BlockPosition |
+floor() |
+
Position |
+getRelative(BlockFace face) |
+
Position |
+getRelative(BlockFace face,
+ double distance) |
+
String |
+getWorld() |
+
double |
+getX() |
+
double |
+getY() |
+
double |
+getZ() |
+
int |
+hashCode() |
+
static Position |
+of(Block block) |
+
static Position |
+of(double x,
+ double y,
+ double z,
+ String world) |
+
static Position |
+of(double x,
+ double y,
+ double z,
+ World world) |
+
static Position |
+of(Location location) |
+
static Position |
+of(Vector3d vector,
+ String world) |
+
static Position |
+of(Vector3d vector,
+ World world) |
+
Region |
+regionWith(Position other) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
Position |
+subtract(double x,
+ double y,
+ double z) |
+
Position |
+subtract(Vector3d vector3d) |
+
Position |
+subtract(Vector3i vector3i) |
+
Location |
+toLocation() |
+
String |
+toString() |
+
Vector3d |
+toVector() |
+
Point |
+withDirection(Direction direction) |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static Position deserialize(JsonElement element)+
public double getX()+
public double getY()+
public double getZ()+
public String getWorld()+
public Vector3d toVector()+
public Location toLocation()+
public BlockPosition floor()+
public Position add(double x, + double y, + double z)+
public Position subtract(double x, + double y, + double z)+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/Region.html b/docs/javadoc/helper/me/lucko/helper/serialize/Region.html new file mode 100644 index 00000000..c55ac247 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/Region.html @@ -0,0 +1,450 @@ + + + + + + +public final class Region +extends Object +implements GsonSerializable+
| Modifier and Type | +Method and Description | +
|---|---|
static Region |
+deserialize(JsonElement element) |
+
boolean |
+equals(Object o) |
+
double |
+getDepth() |
+
double |
+getHeight() |
+
Position |
+getMax() |
+
Position |
+getMin() |
+
double |
+getWidth() |
+
int |
+hashCode() |
+
boolean |
+inRegion(double x,
+ double y,
+ double z) |
+
boolean |
+inRegion(Location loc) |
+
boolean |
+inRegion(Position pos) |
+
static Region |
+of(Position a,
+ Position b) |
+
JsonObject |
+serialize()
+Serializes the object to JSON
+ |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitdeserialize, getDeserializeMethodpublic static Region deserialize(JsonElement element)+
public boolean inRegion(Position pos)+
public boolean inRegion(Location loc)+
public boolean inRegion(double x, + double y, + double z)+
public Position getMin()+
public Position getMax()+
public double getWidth()+
public double getHeight()+
public double getDepth()+
@Nonnull +public JsonObject serialize()+
GsonSerializableserialize in interface GsonSerializableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/Serializers.html b/docs/javadoc/helper/me/lucko/helper/serialize/Serializers.html new file mode 100644 index 00000000..3305876f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/Serializers.html @@ -0,0 +1,307 @@ + + + + + + +public final class Serializers +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Inventory |
+deserializeInventory(JsonElement data,
+ String title) |
+
static ItemStack |
+deserializeItemstack(JsonElement data) |
+
static ItemStack[] |
+deserializeItemstacks(JsonElement data) |
+
static JsonPrimitive |
+serializeInventory(Inventory inventory) |
+
static JsonPrimitive |
+serializeItemstack(ItemStack item) |
+
static JsonPrimitive |
+serializeItemstacks(ItemStack[] items) |
+
public static JsonPrimitive serializeItemstack(ItemStack item)+
public static ItemStack deserializeItemstack(JsonElement data)+
public static JsonPrimitive serializeItemstacks(ItemStack[] items)+
public static JsonPrimitive serializeInventory(Inventory inventory)+
public static ItemStack[] deserializeItemstacks(JsonElement data)+
public static Inventory deserializeInventory(JsonElement data, + String title)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/VectorSerializers.html b/docs/javadoc/helper/me/lucko/helper/serialize/VectorSerializers.html new file mode 100644 index 00000000..46e15a1d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/VectorSerializers.html @@ -0,0 +1,539 @@ + + + + + + +public final class VectorSerializers +extends Object+
public static JsonObject serialize(Vector2d vector2d)+
public static Vector2d deserialize2d(JsonElement element)+
public static JsonObject serialize(Vector2f vector2f)+
public static Vector2f deserialize2f(JsonElement element)+
public static JsonObject serialize(Vector2i vector2i)+
public static Vector2i deserialize2i(JsonElement element)+
public static JsonObject serialize(Vector2l vector2l)+
public static Vector2l deserialize2l(JsonElement element)+
public static JsonObject serialize(Vector3d vector3d)+
public static Vector3d deserialize3d(JsonElement element)+
public static JsonObject serialize(Vector3f vector3f)+
public static Vector3f deserialize3f(JsonElement element)+
public static JsonObject serialize(Vector3i vector3i)+
public static Vector3i deserialize3i(JsonElement element)+
public static JsonObject serialize(Vector3l vector3l)+
public static Vector3l deserialize3l(JsonElement element)+
public static JsonObject serialize(Vector4d vector4d)+
public static Vector4d deserialize4d(JsonElement element)+
public static JsonObject serialize(Vector4f vector4f)+
public static Vector4f deserialize4f(JsonElement element)+
public static JsonObject serialize(Vector4i vector4i)+
public static Vector4i deserialize4i(JsonElement element)+
public static JsonObject serialize(Vector4l vector4l)+
public static Vector4l deserialize4l(JsonElement element)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/BlockPosition.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/BlockPosition.html new file mode 100644 index 00000000..a14fa498 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/BlockPosition.html @@ -0,0 +1,291 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static <T> Map<BlockPosition,T> |
+Metadata.lookupBlocksWithKey(MetadataKey<T> key)
+Gets a map of the blocks with a given metadata key
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
BlockPosition |
+BlockPosition.add(int x,
+ int y,
+ int z) |
+
BlockPosition |
+BlockPosition.add(Vector3i vector3i) |
+
static BlockPosition |
+BlockPosition.deserialize(JsonElement element) |
+
BlockPosition |
+Position.floor() |
+
BlockPosition |
+ChunkPosition.getBlock(int x,
+ int y,
+ int z) |
+
BlockPosition |
+BlockRegion.getMax() |
+
BlockPosition |
+BlockRegion.getMin() |
+
BlockPosition |
+BlockPosition.getRelative(BlockFace face) |
+
BlockPosition |
+BlockPosition.getRelative(BlockFace face,
+ int distance) |
+
static BlockPosition |
+BlockPosition.of(Block block) |
+
static BlockPosition |
+BlockPosition.of(int x,
+ int y,
+ int z,
+ String world) |
+
static BlockPosition |
+BlockPosition.of(int x,
+ int y,
+ int z,
+ World world) |
+
static BlockPosition |
+BlockPosition.of(Location location) |
+
static BlockPosition |
+BlockPosition.of(Vector3i vector,
+ String world) |
+
static BlockPosition |
+BlockPosition.of(Vector3i vector,
+ World world) |
+
BlockPosition |
+BlockPosition.subtract(int x,
+ int y,
+ int z) |
+
BlockPosition |
+BlockPosition.subtract(Vector3i vector3i) |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+BlockRegion.inRegion(BlockPosition pos) |
+
static BlockRegion |
+BlockRegion.of(BlockPosition a,
+ BlockPosition b) |
+
BlockRegion |
+BlockPosition.regionWith(BlockPosition other) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/BlockRegion.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/BlockRegion.html new file mode 100644 index 00000000..55675009 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/BlockRegion.html @@ -0,0 +1,175 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static BlockRegion |
+BlockRegion.deserialize(JsonElement element) |
+
static BlockRegion |
+BlockRegion.of(BlockPosition a,
+ BlockPosition b) |
+
BlockRegion |
+BlockPosition.regionWith(BlockPosition other) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/ChunkPosition.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/ChunkPosition.html new file mode 100644 index 00000000..af741cc0 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/ChunkPosition.html @@ -0,0 +1,249 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
ChunkPosition |
+ChunkPosition.add(int x,
+ int z) |
+
ChunkPosition |
+ChunkPosition.add(Vector2i vector2i) |
+
static ChunkPosition |
+ChunkPosition.deserialize(JsonElement element) |
+
ChunkPosition |
+ChunkRegion.getMax() |
+
ChunkPosition |
+ChunkRegion.getMin() |
+
ChunkPosition |
+ChunkPosition.getRelative(BlockFace face) |
+
ChunkPosition |
+ChunkPosition.getRelative(BlockFace face,
+ int distance) |
+
static ChunkPosition |
+ChunkPosition.of(Chunk location) |
+
static ChunkPosition |
+ChunkPosition.of(int x,
+ int z,
+ String world) |
+
static ChunkPosition |
+ChunkPosition.of(int x,
+ int z,
+ World world) |
+
static ChunkPosition |
+ChunkPosition.of(Vector2i vector,
+ String world) |
+
static ChunkPosition |
+ChunkPosition.of(Vector2i vector,
+ World world) |
+
ChunkPosition |
+ChunkPosition.subtract(int x,
+ int z) |
+
ChunkPosition |
+ChunkPosition.subtract(Vector2i vector2i) |
+
ChunkPosition |
+BlockPosition.toChunk() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+ChunkRegion.inRegion(ChunkPosition pos) |
+
static ChunkRegion |
+ChunkRegion.of(ChunkPosition a,
+ ChunkPosition b) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/ChunkRegion.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/ChunkRegion.html new file mode 100644 index 00000000..1f0be2f1 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/ChunkRegion.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static ChunkRegion |
+ChunkRegion.deserialize(JsonElement element) |
+
static ChunkRegion |
+ChunkRegion.of(ChunkPosition a,
+ ChunkPosition b) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Direction.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Direction.html new file mode 100644 index 00000000..cd40a912 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Direction.html @@ -0,0 +1,210 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static Direction |
+Direction.ZERO |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Direction |
+Direction.deserialize(JsonElement element) |
+
static Direction |
+Direction.from(Location location) |
+
Direction |
+Point.getDirection() |
+
static Direction |
+Direction.of(float yaw,
+ float pitch) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Point |
+Point.of(Position position,
+ Direction direction) |
+
Point |
+Position.withDirection(Direction direction) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/FileStorageHandler.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/FileStorageHandler.html new file mode 100644 index 00000000..6f80e8bc --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/FileStorageHandler.html @@ -0,0 +1,185 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+GsonStorageHandler<T>
+Extension of
+FileStorageHandler implemented using Gson. |
+
| Modifier and Type | +Method and Description | +
|---|---|
static <T> FileStorageHandler<T> |
+FileStorageHandler.build(String fileName,
+ String fileExtension,
+ File dataFolder,
+ Function<Path,T> loadingFunc,
+ BiConsumer<Path,T> savingFunc) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/GsonStorageHandler.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/GsonStorageHandler.html new file mode 100644 index 00000000..c1bbbcee --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/GsonStorageHandler.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Point.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Point.html new file mode 100644 index 00000000..8415bbb1 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Point.html @@ -0,0 +1,191 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Point |
+Point.add(double x,
+ double y,
+ double z) |
+
static Point |
+Point.deserialize(JsonElement element) |
+
static Point |
+Point.of(Location location) |
+
static Point |
+Point.of(Position position,
+ Direction direction) |
+
Point |
+Point.subtract(double x,
+ double y,
+ double z) |
+
Point |
+Position.withDirection(Direction direction) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Position.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Position.html new file mode 100644 index 00000000..0aa37d2d --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Position.html @@ -0,0 +1,313 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Hologram |
+Hologram.create(Position position,
+ List<String> lines)
+Creates and returns a new hologram
+ |
+
void |
+Hologram.updatePosition(Position position)
+Updates the position of the hologram and respawns it
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Position |
+Position.add(double x,
+ double y,
+ double z) |
+
Position |
+Position.add(Vector3d vector3d) |
+
Position |
+Position.add(Vector3i vector3i) |
+
static Position |
+Position.deserialize(JsonElement element) |
+
Position |
+Region.getMax() |
+
Position |
+Region.getMin() |
+
Position |
+Point.getPosition() |
+
Position |
+Position.getRelative(BlockFace face) |
+
Position |
+Position.getRelative(BlockFace face,
+ double distance) |
+
static Position |
+Position.of(Block block) |
+
static Position |
+Position.of(double x,
+ double y,
+ double z,
+ String world) |
+
static Position |
+Position.of(double x,
+ double y,
+ double z,
+ World world) |
+
static Position |
+Position.of(Location location) |
+
static Position |
+Position.of(Vector3d vector,
+ String world) |
+
static Position |
+Position.of(Vector3d vector,
+ World world) |
+
Position |
+Position.subtract(double x,
+ double y,
+ double z) |
+
Position |
+Position.subtract(Vector3d vector3d) |
+
Position |
+Position.subtract(Vector3i vector3i) |
+
Position |
+BlockPosition.toPosition() |
+
Position |
+BlockPosition.toPositionCenter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+Region.inRegion(Position pos) |
+
static Point |
+Point.of(Position position,
+ Direction direction) |
+
static Region |
+Region.of(Position a,
+ Position b) |
+
Region |
+Position.regionWith(Position other) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Region.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Region.html new file mode 100644 index 00000000..4fe70185 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Region.html @@ -0,0 +1,175 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Region |
+Region.deserialize(JsonElement element) |
+
static Region |
+Region.of(Position a,
+ Position b) |
+
Region |
+Position.regionWith(Position other) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Serializers.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Serializers.html new file mode 100644 index 00000000..4f03d352 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/Serializers.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/class-use/VectorSerializers.html b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/VectorSerializers.html new file mode 100644 index 00000000..a369eebb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/class-use/VectorSerializers.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/package-frame.html b/docs/javadoc/helper/me/lucko/helper/serialize/package-frame.html new file mode 100644 index 00000000..9b95e7d5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +| Class | +Description | +
|---|---|
| BlockPosition | +
+ An immutable and serializable block location object
+ |
+
| BlockRegion | +
+ An immutable and serializable block region object
+ |
+
| ChunkPosition | +
+ An immutable and serializable chuck location object
+ |
+
| ChunkRegion | +
+ An immutable and serializable chunk region object
+ |
+
| Direction | +
+ An immutable and serializable direction object
+ |
+
| FileStorageHandler<T> | +
+ Utility class for handling storage file i/o.
+ |
+
| GsonStorageHandler<T> | +
+ Extension of
+FileStorageHandler implemented using Gson. |
+
| Point | +
+ An immutable and serializable position + direction object
+ |
+
| Position | +
+ An immutable and serializable location object
+ |
+
| Region | +
+ An immutable and serializable region object
+ |
+
| Serializers | +
+ Utility methods for converting ItemStacks and Inventories to and from JSON.
+ |
+
| VectorSerializers | +
+ Utility for serializing and deserializing flowpowered Vector instances
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/package-tree.html b/docs/javadoc/helper/me/lucko/helper/serialize/package-tree.html new file mode 100644 index 00000000..7667e3a8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/serialize/package-use.html b/docs/javadoc/helper/me/lucko/helper/serialize/package-use.html new file mode 100644 index 00000000..65e66660 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/serialize/package-use.html @@ -0,0 +1,243 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.serialize | ++ |
| Class and Description | +
|---|
| Position
+ An immutable and serializable location object
+ |
+
| Class and Description | +
|---|
| BlockPosition
+ An immutable and serializable block location object
+ |
+
| Class and Description | +
|---|
| BlockPosition
+ An immutable and serializable block location object
+ |
+
| BlockRegion
+ An immutable and serializable block region object
+ |
+
| ChunkPosition
+ An immutable and serializable chuck location object
+ |
+
| ChunkRegion
+ An immutable and serializable chunk region object
+ |
+
| Direction
+ An immutable and serializable direction object
+ |
+
| FileStorageHandler
+ Utility class for handling storage file i/o.
+ |
+
| Point
+ An immutable and serializable position + direction object
+ |
+
| Position
+ An immutable and serializable location object
+ |
+
| Region
+ An immutable and serializable region object
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/Terminable.html b/docs/javadoc/helper/me/lucko/helper/terminable/Terminable.html new file mode 100644 index 00000000..d349d27c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/Terminable.html @@ -0,0 +1,336 @@ + + + + + + +@FunctionalInterface +public interface Terminable+
| Modifier and Type | +Field and Description | +
|---|---|
static Terminable |
+EMPTY |
+
| Modifier and Type | +Method and Description | +
|---|---|
default void |
+bindWith(TerminableConsumer consumer)
+Registers this terminable with a terminable consumer (usually the plugin instance)
+ |
+
default boolean |
+hasTerminated()
+Used to help cleanup held terminable instances in registries
+ |
+
static Terminable |
+of(Runnable r) |
+
boolean |
+terminate()
+Terminate this instance
+ |
+
static final Terminable EMPTY+
@Nonnull +static Terminable of(@Nonnull + Runnable r)+
boolean terminate()+
default void bindWith(@Nonnull + TerminableConsumer consumer)+
consumer - the terminable consumerdefault boolean hasTerminated()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/TerminableConsumer.html b/docs/javadoc/helper/me/lucko/helper/terminable/TerminableConsumer.html new file mode 100644 index 00000000..2495c79e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/TerminableConsumer.html @@ -0,0 +1,280 @@ + + + + + + +@FunctionalInterface +public interface TerminableConsumer+
Terminables.| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+bind(T terminable)
+Binds with the given terminable.
+ |
+
default <T extends Runnable> |
+bindRunnable(T runnable)
+Binds with the given runnable.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/Terminables.html b/docs/javadoc/helper/me/lucko/helper/terminable/Terminables.html new file mode 100644 index 00000000..c8323467 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/Terminables.html @@ -0,0 +1,241 @@ + + + + + + +public final class Terminables +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Terminable |
+combine(Terminable... terminables) |
+
@Nonnull +public static Terminable combine(@Nonnull + Terminable... terminables)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/class-use/Terminable.html b/docs/javadoc/helper/me/lucko/helper/terminable/class-use/Terminable.html new file mode 100644 index 00000000..fa8314b1 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/class-use/Terminable.html @@ -0,0 +1,413 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.terminable | ++ |
| me.lucko.helper.terminable.registry | ++ |
| me.lucko.helper.utils | ++ |
| Modifier and Type | +Interface and Description | +
|---|---|
static interface |
+Events.Handler<T>
+Responsible for the handling of a given event
+ |
+
static interface |
+Events.MergedHandler<T>
+Responsible for the handling of a merged event
+ |
+
static interface |
+Scheduler.Task
+Represents a scheduled repeating task
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Hologram
+A simple hologram utility.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+Gui.bind(T terminable) |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+ChannelAgent<T>
+Represents an agent for interacting with a
+Channels message streams. |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+ExtendedJavaPlugin.bind(T terminable) |
+
| Modifier and Type | +Field and Description | +
|---|---|
static Terminable |
+Terminable.EMPTY |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+TerminableConsumer.bind(T terminable)
+Binds with the given terminable.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Terminable |
+Terminables.combine(Terminable... terminables) |
+
static Terminable |
+Terminable.of(Runnable r) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Terminable |
+Terminables.combine(Terminable... terminables) |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+TerminableRegistry
+Represents a registry of
+Terminables. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SimpleTerminableRegistry |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+SimpleTerminableRegistry.bind(T terminable) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ServiceCallback<T>
+A wrapper to always provide the latest instance of a service.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/class-use/TerminableConsumer.html b/docs/javadoc/helper/me/lucko/helper/terminable/class-use/TerminableConsumer.html new file mode 100644 index 00000000..5e978bc8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/class-use/TerminableConsumer.html @@ -0,0 +1,307 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.terminable | ++ |
| me.lucko.helper.terminable.composite | ++ |
| me.lucko.helper.terminable.registry | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Gui
+A simple GUI abstraction
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PaginatedGui
+
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DummyHelperPlugin
+Dummy plugin to make the server load this lib.
+ |
+
class |
+ExtendedJavaPlugin
+An "extended" JavaPlugin class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
default void |
+Terminable.bindWith(TerminableConsumer consumer)
+Registers this terminable with a terminable consumer (usually the plugin instance)
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+CompositeTerminable.setup(TerminableConsumer consumer)
+Binds this composite terminable with a terminable consumer
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+TerminableRegistry
+Represents a registry of
+Terminables. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SimpleTerminableRegistry |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/class-use/Terminables.html b/docs/javadoc/helper/me/lucko/helper/terminable/class-use/Terminables.html new file mode 100644 index 00000000..3c4a2979 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/class-use/Terminables.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/CompositeTerminable.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/CompositeTerminable.html new file mode 100644 index 00000000..d2174b0c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/CompositeTerminable.html @@ -0,0 +1,256 @@ + + + + + + +public interface CompositeTerminable
+Terminables, to be easily registered as one.
+
+ CompositeTerminables can be registered with CompositeTerminableConsumer.bindComposite(CompositeTerminable)| Modifier and Type | +Method and Description | +
|---|---|
default void |
+bindWith(CompositeTerminableConsumer consumer)
+Registers this terminable with a terminable consumer (usually the plugin instance)
+ |
+
void |
+setup(TerminableConsumer consumer)
+Binds this composite terminable with a terminable consumer
+ |
+
void setup(@Nonnull + TerminableConsumer consumer)+
consumer - the terminable consumerdefault void bindWith(@Nonnull + CompositeTerminableConsumer consumer)+
consumer - the terminable consumerCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/CompositeTerminableConsumer.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/CompositeTerminableConsumer.html new file mode 100644 index 00000000..675260ad --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/CompositeTerminableConsumer.html @@ -0,0 +1,252 @@ + + + + + + +@FunctionalInterface +public interface CompositeTerminableConsumer+
CompositeTerminables.| Modifier and Type | +Method and Description | +
|---|---|
<T extends CompositeTerminable> |
+bindComposite(T terminable)
+Binds a composite terminable to this consumer
+ |
+
@Nonnull +<T extends CompositeTerminable> T bindComposite(@Nonnull + T terminable)+
T - the terminable class typeterminable - the terminable to bindCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/class-use/CompositeTerminable.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/class-use/CompositeTerminable.html new file mode 100644 index 00000000..661adbb2 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/class-use/CompositeTerminable.html @@ -0,0 +1,212 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.terminable.composite | ++ |
| me.lucko.helper.terminable.registry | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
<T extends CompositeTerminable> |
+ExtendedJavaPlugin.bindComposite(T terminable) |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends CompositeTerminable> |
+CompositeTerminableConsumer.bindComposite(T terminable)
+Binds a composite terminable to this consumer
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends CompositeTerminable> |
+SimpleTerminableRegistry.bindComposite(T terminable) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/class-use/CompositeTerminableConsumer.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/class-use/CompositeTerminableConsumer.html new file mode 100644 index 00000000..e4f179bb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/class-use/CompositeTerminableConsumer.html @@ -0,0 +1,235 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.terminable.composite | ++ |
| me.lucko.helper.terminable.registry | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+DummyHelperPlugin
+Dummy plugin to make the server load this lib.
+ |
+
class |
+ExtendedJavaPlugin
+An "extended" JavaPlugin class.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
default void |
+CompositeTerminable.bindWith(CompositeTerminableConsumer consumer)
+Registers this terminable with a terminable consumer (usually the plugin instance)
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+TerminableRegistry
+Represents a registry of
+Terminables. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SimpleTerminableRegistry |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-frame.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-frame.html new file mode 100644 index 00000000..ffcbdd19 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-frame.html @@ -0,0 +1,22 @@ + + + + + + +| Interface | +Description | +
|---|---|
| CompositeTerminable | +
+ A composite terminable is a class which combines a number
+ of
+Terminables, to be easily registered as one. |
+
| CompositeTerminableConsumer | +
+ Accepts
+CompositeTerminables. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-tree.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-tree.html new file mode 100644 index 00000000..b78f8def --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-tree.html @@ -0,0 +1,136 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-use.html b/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-use.html new file mode 100644 index 00000000..d6f9d598 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/composite/package-use.html @@ -0,0 +1,221 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.terminable.composite | ++ |
| me.lucko.helper.terminable.registry | ++ |
| Class and Description | +
|---|
| CompositeTerminable
+ A composite terminable is a class which combines a number
+ of
+Terminables, to be easily registered as one. |
+
| CompositeTerminableConsumer
+ Accepts
+CompositeTerminables. |
+
| Class and Description | +
|---|
| CompositeTerminable
+ A composite terminable is a class which combines a number
+ of
+Terminables, to be easily registered as one. |
+
| CompositeTerminableConsumer
+ Accepts
+CompositeTerminables. |
+
| Class and Description | +
|---|
| CompositeTerminable
+ A composite terminable is a class which combines a number
+ of
+Terminables, to be easily registered as one. |
+
| CompositeTerminableConsumer
+ Accepts
+CompositeTerminables. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/package-frame.html b/docs/javadoc/helper/me/lucko/helper/terminable/package-frame.html new file mode 100644 index 00000000..317ed5fd --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/package-frame.html @@ -0,0 +1,26 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Terminable | +
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| TerminableConsumer | +
+ Accepts
+Terminables. |
+
| Class | +Description | +
|---|---|
| Terminables | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/package-tree.html b/docs/javadoc/helper/me/lucko/helper/terminable/package-tree.html new file mode 100644 index 00000000..d23eafe8 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/package-tree.html @@ -0,0 +1,144 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/package-use.html b/docs/javadoc/helper/me/lucko/helper/terminable/package-use.html new file mode 100644 index 00000000..1feaacef --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/package-use.html @@ -0,0 +1,370 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.terminable | ++ |
| me.lucko.helper.terminable.composite | ++ |
| me.lucko.helper.terminable.registry | ++ |
| me.lucko.helper.utils | ++ |
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| TerminableConsumer
+ Accepts
+Terminables. |
+
| Class and Description | +
|---|
| TerminableConsumer
+ Accepts
+Terminables. |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| TerminableConsumer
+ Accepts
+Terminables. |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| TerminableConsumer
+ Accepts
+Terminables. |
+
| Class and Description | +
|---|
| TerminableConsumer
+ Accepts
+Terminables. |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
| TerminableConsumer
+ Accepts
+Terminables. |
+
| Class and Description | +
|---|
| Terminable
+ Represents an object that can be unregistered, stopped, or gracefully halted.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/SimpleTerminableRegistry.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/SimpleTerminableRegistry.html new file mode 100644 index 00000000..0bd44fec --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/SimpleTerminableRegistry.html @@ -0,0 +1,430 @@ + + + + + + +public class SimpleTerminableRegistry +extends Object +implements TerminableRegistry+
EMPTY| Constructor and Description | +
|---|
SimpleTerminableRegistry() |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends Terminable> |
+bind(T terminable)
+Binds with the given terminable.
+ |
+
<T extends CompositeTerminable> |
+bindComposite(T terminable)
+Binds a composite terminable to this consumer
+ |
+
void |
+cleanup()
+Removes instances which have already been terminated via
+Terminable.hasTerminated() |
+
boolean |
+hasTerminated()
+Used to help cleanup held terminable instances in registries
+ |
+
boolean |
+terminate()
+Terminate this instance
+ |
+
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreatebindWith, ofbindRunnablepublic SimpleTerminableRegistry()+
@Nonnull +public final <T extends Terminable> T bind(@Nonnull + T terminable)+
TerminableConsumerbind in interface TerminableConsumerT - the terminable typeterminable - the terminable to bind with@Nonnull +public <T extends CompositeTerminable> T bindComposite(@Nonnull + T terminable)+
CompositeTerminableConsumerbindComposite in interface CompositeTerminableConsumerT - the terminable class typeterminable - the terminable to bindpublic final boolean terminate()+
Terminableterminate in interface Terminablepublic final boolean hasTerminated()+
TerminablehasTerminated in interface Terminablepublic final void cleanup()+
TerminableRegistryTerminable.hasTerminated()cleanup in interface TerminableRegistryCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/TerminableRegistry.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/TerminableRegistry.html new file mode 100644 index 00000000..eccf144b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/TerminableRegistry.html @@ -0,0 +1,286 @@ + + + + + + +public interface TerminableRegistry +extends Terminable, TerminableConsumer, CompositeTerminableConsumer+
Terminables.EMPTY| Modifier and Type | +Method and Description | +
|---|---|
default void |
+cleanup()
+Removes instances which have already been terminated via
+Terminable.hasTerminated() |
+
static TerminableRegistry |
+create() |
+
bindWith, hasTerminated, of, terminatebind, bindRunnablebindComposite@Nonnull +static TerminableRegistry create()+
default void cleanup()+
Terminable.hasTerminated()Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/class-use/SimpleTerminableRegistry.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/class-use/SimpleTerminableRegistry.html new file mode 100644 index 00000000..c59e87ed --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/class-use/SimpleTerminableRegistry.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/class-use/TerminableRegistry.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/class-use/TerminableRegistry.html new file mode 100644 index 00000000..1fcb10d3 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/class-use/TerminableRegistry.html @@ -0,0 +1,179 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.terminable.registry | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+SimpleTerminableRegistry |
+
| Modifier and Type | +Method and Description | +
|---|---|
static TerminableRegistry |
+TerminableRegistry.create() |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-frame.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-frame.html new file mode 100644 index 00000000..02d9aa5b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +| Interface | +Description | +
|---|---|
| TerminableRegistry | +
+ Represents a registry of
+Terminables. |
+
| Class | +Description | +
|---|---|
| SimpleTerminableRegistry | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-tree.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-tree.html new file mode 100644 index 00000000..cd2b047c --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-use.html b/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-use.html new file mode 100644 index 00000000..17015a75 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/terminable/registry/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.terminable.registry | ++ |
| Class and Description | +
|---|
| TerminableRegistry
+ Represents a registry of
+Terminables. |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/timings/Timings.html b/docs/javadoc/helper/me/lucko/helper/timings/Timings.html new file mode 100644 index 00000000..8999f987 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/timings/Timings.html @@ -0,0 +1,304 @@ + + + + + + +@NonnullByDefault +public final class Timings +extends Object+
TimingManager| Modifier and Type | +Method and Description | +
|---|---|
static co.aikar.timings.lib.TimingManager |
+get()
+Gets the TimingManager
+ |
+
static co.aikar.timings.lib.MCTiming |
+of(String name) |
+
static co.aikar.timings.lib.MCTiming |
+of(String name,
+ co.aikar.timings.lib.MCTiming parent) |
+
static co.aikar.timings.lib.MCTiming |
+ofStart(String name) |
+
static co.aikar.timings.lib.MCTiming |
+ofStart(String name,
+ co.aikar.timings.lib.MCTiming parent) |
+
public static co.aikar.timings.lib.TimingManager get()+
public static co.aikar.timings.lib.MCTiming ofStart(String name)+
public static co.aikar.timings.lib.MCTiming ofStart(String name, + co.aikar.timings.lib.MCTiming parent)+
public static co.aikar.timings.lib.MCTiming of(String name)+
public static co.aikar.timings.lib.MCTiming of(String name, + co.aikar.timings.lib.MCTiming parent)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/timings/class-use/Timings.html b/docs/javadoc/helper/me/lucko/helper/timings/class-use/Timings.html new file mode 100644 index 00000000..788634db --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/timings/class-use/Timings.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/timings/package-frame.html b/docs/javadoc/helper/me/lucko/helper/timings/package-frame.html new file mode 100644 index 00000000..eddb38c1 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/timings/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| Timings | +
+ Provides access to a
+TimingManager |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/timings/package-tree.html b/docs/javadoc/helper/me/lucko/helper/timings/package-tree.html new file mode 100644 index 00000000..32b370b4 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/timings/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/timings/package-use.html b/docs/javadoc/helper/me/lucko/helper/timings/package-use.html new file mode 100644 index 00000000..505e973b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/timings/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/CollectionUtils.html b/docs/javadoc/helper/me/lucko/helper/utils/CollectionUtils.html new file mode 100644 index 00000000..0fbb930b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/CollectionUtils.html @@ -0,0 +1,241 @@ + + + + + + +public final class CollectionUtils +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static <T> List<List<T>> |
+divideIterable(Iterable<T> source,
+ int subListSize) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/Color.html b/docs/javadoc/helper/me/lucko/helper/utils/Color.html new file mode 100644 index 00000000..f1ae37e0 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/Color.html @@ -0,0 +1,239 @@ + + + + + + +public final class Color +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+colorize(String s) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/CommandMapUtil.html b/docs/javadoc/helper/me/lucko/helper/utils/CommandMapUtil.html new file mode 100644 index 00000000..7fb574fc --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/CommandMapUtil.html @@ -0,0 +1,261 @@ + + + + + + +public final class CommandMapUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static <T extends CommandExecutor> |
+registerCommand(Plugin plugin,
+ T command,
+ String... aliases)
+Registers a CommandExecutor with the server
+ |
+
@Nonnull +public static <T extends CommandExecutor> T registerCommand(@Nonnull + Plugin plugin, + @Nonnull + T command, + @Nonnull + String... aliases)+
T - the command executor class typecommand - the command instancealiases - the command aliasesCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/Cooldown.html b/docs/javadoc/helper/me/lucko/helper/utils/Cooldown.html new file mode 100644 index 00000000..cf24aed5 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/Cooldown.html @@ -0,0 +1,510 @@ + + + + + + +@NonnullByDefault +public class Cooldown +extends Object +implements LongSupplier+
| Modifier and Type | +Field and Description | +
|---|---|
protected long |
+lastCalled |
+
protected long |
+timeout |
+
| Modifier and Type | +Method and Description | +
|---|---|
Cooldown |
+copy()
+Copies the properties of this cooldown to a new instance
+ |
+
long |
+elapsed()
+Returns the elapsed time in milliseconds since the cooldown was last reset, or since creation time
+ |
+
long |
+getAsLong() |
+
long |
+getTimeout()
+Gets the timeout in milliseconds for this cooldown
+ |
+
static Cooldown |
+of(long amount,
+ TimeUnit unit)
+Creates a cooldown lasting a specified amount of time
+ |
+
static Cooldown |
+ofTicks(long ticks)
+Creates a cooldown lasting a number of game ticks
+ |
+
long |
+remainingMillis()
+Gets the time in milliseconds until the cooldown will become inactive.
+ |
+
long |
+remainingTime(TimeUnit unit)
+Gets the time until the cooldown will become inactive.
+ |
+
void |
+reset()
+Resets the cooldown
+ |
+
boolean |
+test()
+Returns true if the cooldown is not active, and then resets the timer
+ |
+
boolean |
+testSilently()
+Returns true if the cooldown is not active
+ |
+
protected long lastCalled+
protected final long timeout+
public static Cooldown ofTicks(long ticks)+
ticks - the number of tickspublic static Cooldown of(long amount, + TimeUnit unit)+
amount - the amount of timeunit - the unit of timepublic boolean test()+
If the cooldown is currently active, the timer is not reset.
public boolean testSilently()+
public long elapsed()+
public void reset()+
public long remainingMillis()+
If the cooldown is not active, this method returns 0.
public long remainingTime(TimeUnit unit)+
If the cooldown is not active, this method returns 0.
unit - the unit to return inpublic long getAsLong()+
getAsLong in interface LongSupplierpublic long getTimeout()+
public Cooldown copy()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/CooldownCollection.html b/docs/javadoc/helper/me/lucko/helper/utils/CooldownCollection.html new file mode 100644 index 00000000..8b6e7625 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/CooldownCollection.html @@ -0,0 +1,475 @@ + + + + + + +T - the key type@NonnullByDefault +public class CooldownCollection<T> +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected LoadingCache<String,Cooldown> |
+cache |
+
protected Function<T,String> |
+mappingFunc |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CooldownCollection<String> |
+create(Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
static <T> CooldownCollection<T> |
+create(Function<T,String> mappingFunc,
+ Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
static <T> CooldownCollection<T> |
+createWithToString(Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
long |
+elapsed(T t) |
+
Cooldown |
+get(T t)
+Gets the internal cooldown instance associated with the given key
+ |
+
long |
+remainingMillis(T t) |
+
long |
+remainingTime(T t,
+ TimeUnit unit) |
+
void |
+reset(T t) |
+
boolean |
+test(T t) |
+
boolean |
+testSilently(T t) |
+
protected final LoadingCache<String,Cooldown> cache+
public static CooldownCollection<String> create(Cooldown base)+
base - the cooldown to base offpublic static <T> CooldownCollection<T> create(Function<T,String> mappingFunc, + Cooldown base)+
T - the key typemappingFunc - the mapping function from the key type to Stringbase - the cooldown to base offpublic static <T> CooldownCollection<T> createWithToString(Cooldown base)+
The mapping from key type to string is defined by the behaviour of Object.toString()
T - the key typebase - the cooldown to base offpublic Cooldown get(T t)+
The inline Cooldown methods in this class should be used to access the functionality of the cooldown as opposed + to calling the methods directly via the instance returned by this method.
t - the keypublic boolean test(T t)+
public boolean testSilently(T t)+
public long elapsed(T t)+
public void reset(T t)+
public long remainingMillis(T t)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/Cycle.html b/docs/javadoc/helper/me/lucko/helper/utils/Cycle.html new file mode 100644 index 00000000..c2bc40bd --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/Cycle.html @@ -0,0 +1,384 @@ + + + + + + +E - the element typepublic class Cycle<E> +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
protected int |
+index |
+
protected List<E> |
+objects |
+
| Constructor and Description | +
|---|
Cycle(List<E> objects) |
+
| Modifier and Type | +Method and Description | +
|---|---|
E |
+back() |
+
E |
+current() |
+
List<E> |
+getBacking() |
+
int |
+getIndex() |
+
E |
+next() |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/ImmutableCollectors.html b/docs/javadoc/helper/me/lucko/helper/utils/ImmutableCollectors.html new file mode 100644 index 00000000..1d1e78e6 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/ImmutableCollectors.html @@ -0,0 +1,314 @@ + + + + + + +@NonnullByDefault +public final class ImmutableCollectors +extends Object+
Collector using Guava's immutable collections.| Modifier and Type | +Method and Description | +
|---|---|
static <T,K,V> Collector<T,?,ImmutableBiMap<K,V>> |
+toBiMap(Function<? super T,? extends K> keyMapper,
+ Function<? super T,? extends V> valueMapper) |
+
static <T> Collector<T,ImmutableList.Builder<T>,ImmutableList<T>> |
+toList() |
+
static <T,K,V> Collector<T,ImmutableMap.Builder<K,V>,ImmutableMap<K,V>> |
+toMap(Function<? super T,? extends K> keyMapper,
+ Function<? super T,? extends V> valueMapper) |
+
static <T> Collector<T,ImmutableSet.Builder<T>,ImmutableSet<T>> |
+toSet() |
+
static <T,K,V> Collector<T,?,ImmutableSortedMap<K,V>> |
+toSortedMap(Comparator<? super K> comparator,
+ Function<? super T,? extends K> keyMapper,
+ Function<? super T,? extends V> valueMapper) |
+
static <E> Collector<E,?,ImmutableSortedSet<E>> |
+toSortedSet(Comparator<? super E> comparator) |
+
public static <T> Collector<T,ImmutableList.Builder<T>,ImmutableList<T>> toList()+
public static <T> Collector<T,ImmutableSet.Builder<T>,ImmutableSet<T>> toSet()+
public static <E> Collector<E,?,ImmutableSortedSet<E>> toSortedSet(Comparator<? super E> comparator)+
public static <T,K,V> Collector<T,ImmutableMap.Builder<K,V>,ImmutableMap<K,V>> toMap(Function<? super T,? extends K> keyMapper, + Function<? super T,? extends V> valueMapper)+
public static <T,K,V> Collector<T,?,ImmutableBiMap<K,V>> toBiMap(Function<? super T,? extends K> keyMapper, + Function<? super T,? extends V> valueMapper)+
public static <T,K,V> Collector<T,?,ImmutableSortedMap<K,V>> toSortedMap(Comparator<? super K> comparator, + Function<? super T,? extends K> keyMapper, + Function<? super T,? extends V> valueMapper)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/LoaderUtils.html b/docs/javadoc/helper/me/lucko/helper/utils/LoaderUtils.html new file mode 100644 index 00000000..63ed30b3 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/LoaderUtils.html @@ -0,0 +1,241 @@ + + + + + + +public final class LoaderUtils +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static JavaPlugin |
+getPlugin() |
+
@Nonnull +public static JavaPlugin getPlugin()+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/Log.html b/docs/javadoc/helper/me/lucko/helper/utils/Log.html new file mode 100644 index 00000000..4da6d34a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/Log.html @@ -0,0 +1,269 @@ + + + + + + +public final class Log +extends Object+
Bukkit.getLogger()| Modifier and Type | +Method and Description | +
|---|---|
static void |
+info(String s) |
+
static void |
+severe(String s) |
+
static void |
+warn(String s) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/Players.html b/docs/javadoc/helper/me/lucko/helper/utils/Players.html new file mode 100644 index 00000000..829ddf21 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/Players.html @@ -0,0 +1,925 @@ + + + + + + +@NonnullByDefault +public final class Players +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static Collection<Player> |
+all()
+Gets all players on the server.
+ |
+
static Collection<OfflinePlayer> |
+allOffline() |
+
static void |
+forEach(Consumer<Player> consumer)
+Applies a given action to all players on the server
+ |
+
static void |
+forEachIfPlayer(Iterable<Object> objects,
+ Consumer<Player> consumer)
+Applies an action to each object in the iterable, if it is a player.
+ |
+
static void |
+forEachInRange(Location center,
+ double radius,
+ Consumer<Player> consumer)
+Applies an action to all players within a given radius of a point
+ |
+
static void |
+forEachOffline(Consumer<OfflinePlayer> consumer) |
+
static Optional<Player> |
+get(String username)
+Gets a player by username.
+ |
+
static Optional<Player> |
+get(UUID uuid)
+Gets a player by uuid.
+ |
+
static Player |
+getNullable(String username)
+Gets a player by username.
+ |
+
static Player |
+getNullable(UUID uuid)
+Gets a player by uuid.
+ |
+
static Optional<OfflinePlayer> |
+getOffline(String username) |
+
static Optional<OfflinePlayer> |
+getOffline(UUID uuid) |
+
static OfflinePlayer |
+getOfflineNullable(String username) |
+
static OfflinePlayer |
+getOfflineNullable(UUID uuid) |
+
static void |
+msg(CommandSender sender,
+ String... msgs)
+Messages a sender a set of messages.
+ |
+
static void |
+playSound(Location location,
+ Sound sound) |
+
static void |
+playSound(Player player,
+ Location location,
+ Sound sound) |
+
static void |
+playSound(Player player,
+ Sound sound) |
+
static void |
+resetFlySpeed(Player player) |
+
static void |
+resetWalkSpeed(Player player) |
+
static void |
+sendBlockChange(Player player,
+ Block block,
+ Material type) |
+
static void |
+sendBlockChange(Player player,
+ Block block,
+ Material type,
+ int data) |
+
static void |
+sendBlockChange(Player player,
+ Location loc,
+ Material type) |
+
static void |
+sendBlockChange(Player player,
+ Location loc,
+ Material type,
+ int data) |
+
static void |
+spawnEffect(Location location,
+ Effect effect) |
+
static void |
+spawnEffect(Location location,
+ Effect effect,
+ int amount) |
+
static void |
+spawnEffect(Player player,
+ Location location,
+ Effect effect) |
+
static void |
+spawnEffect(Player player,
+ Location location,
+ Effect effect,
+ int amount) |
+
static void |
+spawnParticle(Location location,
+ Particle particle) |
+
static void |
+spawnParticle(Location location,
+ Particle particle,
+ int amount) |
+
static void |
+spawnParticle(Player player,
+ Location location,
+ Particle particle) |
+
static void |
+spawnParticle(Player player,
+ Location location,
+ Particle particle,
+ int amount) |
+
static void |
+spawnParticleOffset(Location location,
+ Particle particle,
+ double offset) |
+
static void |
+spawnParticleOffset(Location location,
+ Particle particle,
+ int amount,
+ double offset) |
+
static void |
+spawnParticleOffset(Player player,
+ Location location,
+ Particle particle,
+ double offset) |
+
static void |
+spawnParticleOffset(Player player,
+ Location location,
+ Particle particle,
+ int amount,
+ double offset) |
+
static Stream<Player> |
+stream()
+Gets a stream of all players on the server.
+ |
+
static Stream<Player> |
+streamInRange(Location center,
+ double radius)
+Gets a stream of all players within a given radius of a point
+ |
+
static Stream<OfflinePlayer> |
+streamOffline() |
+
@Nullable +public static Player getNullable(UUID uuid)+
uuid - the uuidpublic static Optional<Player> get(UUID uuid)+
uuid - the uuid@Nullable +public static Player getNullable(String username)+
username - the players usernamepublic static Optional<Player> get(String username)+
username - the players usernamepublic static Collection<Player> all()+
public static Stream<Player> stream()+
public static void forEach(Consumer<Player> consumer)+
consumer - the action to applypublic static void forEachIfPlayer(Iterable<Object> objects, + Consumer<Player> consumer)+
objects - the objects to iterateconsumer - the action to applypublic static Stream<Player> streamInRange(Location center, + double radius)+
center - the pointradius - the radiuspublic static void forEachInRange(Location center, + double radius, + Consumer<Player> consumer)+
center - the pointradius - the radiusconsumer - the action to applypublic static void msg(CommandSender sender, + String... msgs)+
sender - the sendermsgs - the messages to send@Nullable +public static OfflinePlayer getOfflineNullable(UUID uuid)+
public static Optional<OfflinePlayer> getOffline(UUID uuid)+
@Nullable +public static OfflinePlayer getOfflineNullable(String username)+
public static Optional<OfflinePlayer> getOffline(String username)+
public static Collection<OfflinePlayer> allOffline()+
public static Stream<OfflinePlayer> streamOffline()+
public static void forEachOffline(Consumer<OfflinePlayer> consumer)+
public static void sendBlockChange(Player player, + Location loc, + Material type, + int data)+
public static void sendBlockChange(Player player, + Block block, + Material type, + int data)+
public static void sendBlockChange(Player player, + Location loc, + Material type)+
public static void sendBlockChange(Player player, + Block block, + Material type)+
public static void spawnParticle(Player player, + Location location, + Particle particle)+
public static void spawnParticle(Player player, + Location location, + Particle particle, + int amount)+
public static void spawnParticle(Location location, + Particle particle, + int amount)+
public static void spawnParticleOffset(Player player, + Location location, + Particle particle, + double offset)+
public static void spawnParticleOffset(Location location, + Particle particle, + double offset)+
public static void spawnParticleOffset(Player player, + Location location, + Particle particle, + int amount, + double offset)+
public static void spawnParticleOffset(Location location, + Particle particle, + int amount, + double offset)+
public static void spawnEffect(Player player, + Location location, + Effect effect)+
public static void spawnEffect(Player player, + Location location, + Effect effect, + int amount)+
public static void spawnEffect(Location location, + Effect effect, + int amount)+
public static void resetWalkSpeed(Player player)+
public static void resetFlySpeed(Player player)+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/ServiceCallback.html b/docs/javadoc/helper/me/lucko/helper/utils/ServiceCallback.html new file mode 100644 index 00000000..daf49ed3 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/ServiceCallback.html @@ -0,0 +1,437 @@ + + + + + + +T - the service class type@NonnullByDefault +public final class ServiceCallback<T> +extends Object +implements Terminable+
EMPTY| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
Optional<T> |
+get()
+Gets the service provider.
+ |
+
T |
+getNullable()
+Gets the service provider, or null if it is not provided for.
+ |
+
int |
+hashCode() |
+
boolean |
+hasTerminated()
+Used to help cleanup held terminable instances in registries
+ |
+
static <T> ServiceCallback<T> |
+of(Class<T> serviceClass)
+Create a new ServiceCallback for the given class.
+ |
+
void |
+refresh()
+Refreshes the backing instance of the service
+ |
+
boolean |
+terminate()
+Terminate this instance
+ |
+
String |
+toString() |
+
clone, finalize, getClass, notify, notifyAll, wait, wait, waitbindWith, ofpublic static <T> ServiceCallback<T> of(Class<T> serviceClass)+
T - the service class typeserviceClass - the service classpublic void refresh()+
@Nullable +public T getNullable()+
public Optional<T> get()+
public boolean terminate()+
Terminableterminate in interface Terminablepublic boolean hasTerminated()+
TerminablehasTerminated in interface TerminableCopyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/TimeUtil.html b/docs/javadoc/helper/me/lucko/helper/utils/TimeUtil.html new file mode 100644 index 00000000..eefa6e20 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/TimeUtil.html @@ -0,0 +1,280 @@ + + + + + + +public final class TimeUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static long |
+now() |
+
static long |
+nowUnix() |
+
static String |
+toLongForm(long seconds) |
+
static String |
+toShortForm(long seconds) |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/annotation/NonnullByDefault.html b/docs/javadoc/helper/me/lucko/helper/utils/annotation/NonnullByDefault.html new file mode 100644 index 00000000..0a7ea8cc --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/annotation/NonnullByDefault.html @@ -0,0 +1,169 @@ + + + + + + +@Nonnull + @Documented + @TypeQualifierDefault(value={FIELD,METHOD,PARAMETER}) + @Retention(value=RUNTIME) +public @interface NonnullByDefault+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/annotation/class-use/NonnullByDefault.html b/docs/javadoc/helper/me/lucko/helper/utils/annotation/class-use/NonnullByDefault.html new file mode 100644 index 00000000..87219faa --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/annotation/class-use/NonnullByDefault.html @@ -0,0 +1,652 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.function.chain | ++ |
| me.lucko.helper.gson | ++ |
| me.lucko.helper.item | ++ |
| me.lucko.helper.maven | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.messaging.bungee | ++ |
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.scoreboard | ++ |
| me.lucko.helper.timings | ++ |
| me.lucko.helper.utils | ++ |
| Package | +Description | +
|---|---|
| me.lucko.helper.serialize | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Commands
+A functional command handling utility.
+ |
+
static interface |
+Commands.CommandBuilder<T extends CommandSender>
+Builds a
+Commands.FunctionalCommand |
+
static interface |
+Commands.CommandContext<T extends CommandSender>
+Represents the context for a command call
+ |
+
static interface |
+Commands.CommandHandler<T extends CommandSender>
+Represents a handler for a
+Commands.FunctionalCommand |
+
static interface |
+Commands.FunctionalCommand
+Represents a command built from functional predicate calls
+ |
+
class |
+Events
+A functional event listening utility.
+ |
+
static interface |
+Events.DefaultFilters
+Provides a set of useful default filters for passing to
+Events.HandlerBuilder.filter(Predicate). |
+
static interface |
+Events.Handler<T>
+Responsible for the handling of a given event
+ |
+
static interface |
+Events.HandlerBuilder<T extends Event>
+Builds a
+Events.Handler |
+
static interface |
+Events.MergedHandler<T>
+Responsible for the handling of a merged event
+ |
+
static interface |
+Events.MergedHandlerBuilder<T>
+Builds a
+Events.MergedHandler |
+
class |
+Helper
+Base class for helper, which mainly just proxies calls to
+Bukkit.getServer() for convenience. |
+
class |
+Scheduler
+A utility class to help with scheduling.
+ |
+
static interface |
+Scheduler.Task
+Represents a scheduled repeating task
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+Chain<T>
+A simplified version of Java 8's
+Stream API. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JsonBuilder
+Builder utilities for creating GSON Objects/Arrays.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ItemStackBuilder
+Easily construct
+ItemStack instances |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+LibraryLoader
+Resolves
+MavenLibrary annotations for a class, and loads the dependency
+ into the classloader. |
+
static class |
+LibraryLoader.Dependency |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Gui
+A simple GUI abstraction
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PaginatedGui
+
+ |
+
class |
+PaginatedGuiBuilder
+Specification class for a
+PaginatedGui. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+MenuPopulator
+A utility to help place items into a
+Gui |
+
class |
+MenuScheme
+Helps to populate a menu with border items
+ |
+
class |
+StandardSchemeMappings
+Contains a number of default
+SchemeMappings. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AbstractMessenger
+An abstract implementation of
+Messenger. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+BungeeMessaging
+Wrapper class for the BungeeCord Plugin Messaging API, providing callbacks to read response data
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+MetadataKey<T>
+A MetadataKey can be mapped to values in a
+MetadataMap. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PacketScoreboard
+A thread-safe scoreboard using ProtocolLib
+ |
+
class |
+PacketScoreboardObjective
+Wrapper for PacketPlayOutScoreboardObjective, PacketPlayOutScoreboardScore and PacketPlayOutScoreboardDisplayObjective
+ |
+
class |
+PacketScoreboardTeam
+Packet wrapper for PacketPlayOutScoreboardTeam
+
+ http://wiki.vg/Protocol#Teams
+ |
+
interface |
+Scoreboard
+Represents a Scoreboard on the server
+ |
+
interface |
+ScoreboardObjective
+Represents a specific objective on a
+Scoreboard. |
+
interface |
+ScoreboardTeam
+Represents a specific team on a
+Scoreboard. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Timings
+Provides access to a
+TimingManager |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+Cooldown
+A simple cooldown abstraction
+ |
+
class |
+CooldownCollection<T>
+A collection of mapped Cooldown instances
+ |
+
class |
+ImmutableCollectors
+Immutable implementations of
+Collector using Guava's immutable collections. |
+
class |
+Players
+A collection of Player related utilities
+ |
+
class |
+ServiceCallback<T>
+A wrapper to always provide the latest instance of a service.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-frame.html b/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-frame.html new file mode 100644 index 00000000..a57371c2 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Annotation Type | +Description | +
|---|---|
| NonnullByDefault | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-tree.html b/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-tree.html new file mode 100644 index 00000000..6031529f --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-tree.html @@ -0,0 +1,135 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-use.html b/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-use.html new file mode 100644 index 00000000..43f518c9 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/annotation/package-use.html @@ -0,0 +1,406 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.function.chain | ++ |
| me.lucko.helper.gson | ++ |
| me.lucko.helper.item | ++ |
| me.lucko.helper.maven | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.messaging.bungee | ++ |
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.scoreboard | ++ |
| me.lucko.helper.timings | ++ |
| me.lucko.helper.utils | ++ |
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
| Class and Description | +
|---|
| NonnullByDefault | +
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/CollectionUtils.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/CollectionUtils.html new file mode 100644 index 00000000..9da7124a --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/CollectionUtils.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/Color.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Color.html new file mode 100644 index 00000000..d768291b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Color.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/CommandMapUtil.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/CommandMapUtil.html new file mode 100644 index 00000000..95316750 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/CommandMapUtil.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/Cooldown.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Cooldown.html new file mode 100644 index 00000000..288f4456 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Cooldown.html @@ -0,0 +1,344 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(Cooldown cooldown)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(Cooldown cooldown)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(Cooldown cooldown)
+Tests the command attempt against the given cooldown.
+ |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(Cooldown cooldown,
+ String failureMessage)
+Tests the command attempt against the given cooldown.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(Cooldown cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+test() returns true. |
+
| Modifier and Type | +Method and Description | +
|---|---|
static MetadataKey<Cooldown> |
+MetadataKey.createCooldownKey(String id) |
+
| Modifier and Type | +Field and Description | +
|---|---|
protected LoadingCache<String,Cooldown> |
+CooldownCollection.cache |
+
| Modifier and Type | +Method and Description | +
|---|---|
Cooldown |
+Cooldown.copy()
+Copies the properties of this cooldown to a new instance
+ |
+
Cooldown |
+CooldownCollection.get(T t)
+Gets the internal cooldown instance associated with the given key
+ |
+
static Cooldown |
+Cooldown.of(long amount,
+ TimeUnit unit)
+Creates a cooldown lasting a specified amount of time
+ |
+
static Cooldown |
+Cooldown.ofTicks(long ticks)
+Creates a cooldown lasting a number of game ticks
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CooldownCollection<String> |
+CooldownCollection.create(Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
static <T> CooldownCollection<T> |
+CooldownCollection.create(Function<T,String> mappingFunc,
+ Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
static <T> CooldownCollection<T> |
+CooldownCollection.createWithToString(Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/CooldownCollection.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/CooldownCollection.html new file mode 100644 index 00000000..664f579b --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/CooldownCollection.html @@ -0,0 +1,238 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.HandlerBuilder<T> |
+Events.HandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
Events.MergedHandlerBuilder<T> |
+Events.MergedHandlerBuilder.withCooldown(CooldownCollection<? super T> cooldown,
+ BiConsumer<Cooldown,? super T> cooldownFailConsumer)
+Adds a filter to the handler, only allowing it to pass if
+Cooldown.test() returns true. |
+
default Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(CooldownCollection<T> cooldown)
+Tests the command attempt against the given cooldown.
+ |
+
Commands.CommandBuilder<T> |
+Commands.CommandBuilder.withCooldown(CooldownCollection<T> cooldown,
+ String failureMessage)
+Tests the command attempt against the given cooldown.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static CooldownCollection<String> |
+CooldownCollection.create(Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
static <T> CooldownCollection<T> |
+CooldownCollection.create(Function<T,String> mappingFunc,
+ Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
static <T> CooldownCollection<T> |
+CooldownCollection.createWithToString(Cooldown base)
+Creates a new collection with the cooldown properties defined by the base instance
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/Cycle.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Cycle.html new file mode 100644 index 00000000..ce9f41fc --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Cycle.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/ImmutableCollectors.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/ImmutableCollectors.html new file mode 100644 index 00000000..eb84bcc7 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/ImmutableCollectors.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/LoaderUtils.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/LoaderUtils.html new file mode 100644 index 00000000..dfb015ad --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/LoaderUtils.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/Log.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Log.html new file mode 100644 index 00000000..3494ebbf --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Log.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/Players.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Players.html new file mode 100644 index 00000000..b6d72f30 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/Players.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/ServiceCallback.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/ServiceCallback.html new file mode 100644 index 00000000..fe14059e --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/ServiceCallback.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper.utils | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static <T> ServiceCallback<T> |
+ServiceCallback.of(Class<T> serviceClass)
+Create a new ServiceCallback for the given class.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/class-use/TimeUtil.html b/docs/javadoc/helper/me/lucko/helper/utils/class-use/TimeUtil.html new file mode 100644 index 00000000..03f97605 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/class-use/TimeUtil.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/package-frame.html b/docs/javadoc/helper/me/lucko/helper/utils/package-frame.html new file mode 100644 index 00000000..f6eb11e1 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +| Class | +Description | +
|---|---|
| CollectionUtils | ++ |
| Color | ++ |
| CommandMapUtil | ++ |
| Cooldown | +
+ A simple cooldown abstraction
+ |
+
| CooldownCollection<T> | +
+ A collection of mapped Cooldown instances
+ |
+
| Cycle<E> | +
+ A cycle of elements, backed by a list.
+ |
+
| ImmutableCollectors | +
+ Immutable implementations of
+Collector using Guava's immutable collections. |
+
| LoaderUtils | +
+ Provides the instance which loaded the helper classes into the server
+ |
+
| Log | +
+ Utility for quickly accessing a logger instance without using
+Bukkit.getLogger() |
+
| Players | +
+ A collection of Player related utilities
+ |
+
| ServiceCallback<T> | +
+ A wrapper to always provide the latest instance of a service.
+ |
+
| TimeUtil | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/package-tree.html b/docs/javadoc/helper/me/lucko/helper/utils/package-tree.html new file mode 100644 index 00000000..5f120c96 --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/package-tree.html @@ -0,0 +1,150 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/me/lucko/helper/utils/package-use.html b/docs/javadoc/helper/me/lucko/helper/utils/package-use.html new file mode 100644 index 00000000..54221eeb --- /dev/null +++ b/docs/javadoc/helper/me/lucko/helper/utils/package-use.html @@ -0,0 +1,218 @@ + + + + + + +| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.utils | ++ |
| Class and Description | +
|---|
| Cooldown
+ A simple cooldown abstraction
+ |
+
| CooldownCollection
+ A collection of mapped Cooldown instances
+ |
+
| Class and Description | +
|---|
| Cooldown
+ A simple cooldown abstraction
+ |
+
| Class and Description | +
|---|
| Cooldown
+ A simple cooldown abstraction
+ |
+
| CooldownCollection
+ A collection of mapped Cooldown instances
+ |
+
| ServiceCallback
+ A wrapper to always provide the latest instance of a service.
+ |
+
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/overview-frame.html b/docs/javadoc/helper/overview-frame.html new file mode 100644 index 00000000..6372d477 --- /dev/null +++ b/docs/javadoc/helper/overview-frame.html @@ -0,0 +1,45 @@ + + + + + + ++ + diff --git a/docs/javadoc/helper/overview-summary.html b/docs/javadoc/helper/overview-summary.html new file mode 100644 index 00000000..39b1232e --- /dev/null +++ b/docs/javadoc/helper/overview-summary.html @@ -0,0 +1,232 @@ + + + + + + +
| Package | +Description | +
|---|---|
| me.lucko.helper | ++ |
| me.lucko.helper.function | ++ |
| me.lucko.helper.function.chain | ++ |
| me.lucko.helper.gson | ++ |
| me.lucko.helper.hologram | ++ |
| me.lucko.helper.interfaces | ++ |
| me.lucko.helper.item | ++ |
| me.lucko.helper.maven | ++ |
| me.lucko.helper.menu | ++ |
| me.lucko.helper.menu.paginated | ++ |
| me.lucko.helper.menu.scheme | ++ |
| me.lucko.helper.messaging | ++ |
| me.lucko.helper.messaging.bungee | ++ |
| me.lucko.helper.metadata | ++ |
| me.lucko.helper.plugin | ++ |
| me.lucko.helper.plugin.ap | ++ |
| me.lucko.helper.scoreboard | ++ |
| me.lucko.helper.serialize | ++ |
| me.lucko.helper.terminable | ++ |
| me.lucko.helper.terminable.composite | ++ |
| me.lucko.helper.terminable.registry | ++ |
| me.lucko.helper.timings | ++ |
| me.lucko.helper.utils | ++ |
| me.lucko.helper.utils.annotation | ++ |
Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/overview-tree.html b/docs/javadoc/helper/overview-tree.html new file mode 100644 index 00000000..58b81a9d --- /dev/null +++ b/docs/javadoc/helper/overview-tree.html @@ -0,0 +1,331 @@ + + + + + + +Copyright © 2017. All rights reserved.
+ + diff --git a/docs/javadoc/helper/package-list b/docs/javadoc/helper/package-list new file mode 100644 index 00000000..d87894fd --- /dev/null +++ b/docs/javadoc/helper/package-list @@ -0,0 +1,24 @@ +me.lucko.helper +me.lucko.helper.function +me.lucko.helper.function.chain +me.lucko.helper.gson +me.lucko.helper.hologram +me.lucko.helper.interfaces +me.lucko.helper.item +me.lucko.helper.maven +me.lucko.helper.menu +me.lucko.helper.menu.paginated +me.lucko.helper.menu.scheme +me.lucko.helper.messaging +me.lucko.helper.messaging.bungee +me.lucko.helper.metadata +me.lucko.helper.plugin +me.lucko.helper.plugin.ap +me.lucko.helper.scoreboard +me.lucko.helper.serialize +me.lucko.helper.terminable +me.lucko.helper.terminable.composite +me.lucko.helper.terminable.registry +me.lucko.helper.timings +me.lucko.helper.utils +me.lucko.helper.utils.annotation diff --git a/docs/javadoc/helper/resources/fonts/dejavu.css b/docs/javadoc/helper/resources/fonts/dejavu.css new file mode 100644 index 00000000..82b867f5 --- /dev/null +++ b/docs/javadoc/helper/resources/fonts/dejavu.css @@ -0,0 +1 @@ +h1{font-family:"Dejavu Sans";font-size:24px;font-style:normal;font-variant:normal;font-weight:500;line-height:26.4px;}h3{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:500;line-height:15.4px;}p{font-family:"Dejavu Sans";font-size:14px;font-style:normal;font-variant:normal;font-weight:400;line-height:20px;}blockquote{font-family:"Dejavu Sans";font-size:21px;font-style:normal;font-variant:normal;font-weight:400;line-height:30px;}pre{font-family:"Dejavu Sans";font-size:13px;font-style:normal;font-variant:normal;font-weight:400;line-height:18.5714px;} diff --git a/docs/javadoc/helper/script.js b/docs/javadoc/helper/script.js new file mode 100644 index 00000000..b3463569 --- /dev/null +++ b/docs/javadoc/helper/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadoc/helper/stylesheet.css b/docs/javadoc/helper/stylesheet.css new file mode 100644 index 00000000..98055b22 --- /dev/null +++ b/docs/javadoc/helper/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.useSummary td.colFirst, .useSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +}