Skip to content

Commit

Permalink
Update pages content
Browse files Browse the repository at this point in the history
  • Loading branch information
lucko committed Sep 24, 2017
1 parent 49e0a76 commit fcbf72c
Show file tree
Hide file tree
Showing 419 changed files with 99,433 additions and 19 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ A utility to reduce boilerplate code in Bukkit plugins. It gets boring writing t

### Modules
##### [`helper`](https://github.com/lucko/helper/tree/master/helper): The main helper project
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper/target/helper.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](#helper) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper/)
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper/target/helper.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](https://github.com/lucko/helper#helperr) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper/javadoc/helper/)

##### [`helper-sql`](https://github.com/lucko/helper/tree/master/helper-sql): Provides SQL datasources using HikariCP.
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-sql/target/helper-sql.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](#helper-sql) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper-sql/)
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-sql/target/helper-sql.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](https://github.com/lucko/helper#helper-sql) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper/javadoc/helper-sql/)

##### [`helper-redis`](https://github.com/lucko/helper/tree/master/helper-redis): Provides Redis clients and implements the helper Messaging system using Jedis.
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-redis/target/helper-redis.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](#helper-redis) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper-redis/)
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-redis/target/helper-redis.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](https://github.com/lucko/helper#helper-redis) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper/javadoc/helper-redis/)

##### [`helper-mongo`](https://github.com/lucko/helper/tree/master/helper-mongo): Provides MongoDB datasources.
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-mongo/target/helper-mongo.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](#helper-mongo) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper-mongo/)
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-mongo/target/helper-mongo.jar) [![Dependency Info](https://img.shields.io/badge/api-dependency_info-orange.svg)](https://github.com/lucko/helper#helper-mongo) [![JavaDoc](https://img.shields.io/badge/api-javadoc-blue.svg)](https://lucko.me/helper/javadoc/helper-mongo/)

##### [`helper-lilypad`](https://github.com/lucko/helper/tree/master/helper-lilypad): Implements the helper Messaging system using LilyPad.
[![Artifact](https://img.shields.io/badge/build-artifact-green.svg)](https://ci.lucko.me/job/helper/lastSuccessfulBuild/artifact/helper-lilypad/target/helper-lilypad.jar)
Expand Down
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
theme: jekyll-theme-midnight
theme: jekyll-theme-cayman
27 changes: 13 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# helper [![Build Status](https://ci.lucko.me/job/helper/badge/icon)](https://ci.lucko.me/job/helper/)
A utility to reduce boilerplate code in Bukkit plugins. It gets boring writing the same old stuff again and again. :)

### Modules
##### [`helper`](https://github.com/lucko/helper/tree/master/helper): The main helper project
Expand Down Expand Up @@ -40,7 +39,7 @@ A utility to reduce boilerplate code in Bukkit plugins. It gets boring writing t


## Features
### [`Events`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/Events.java)
### Events
helper adds a functional event handling utility. It allows you to dynamically register event listeners on the fly, without having to break out of logic, or define listeners as their own method.

Instead of *implementing Listener*, creating a *new method* annotated with *@EventHandler*, and *registering* your listener with the plugin manager, with helper, you can subscribe to an event with one simple line of code. This allows you to define multiple listeners in the same class, and register then selectively.
Expand Down Expand Up @@ -108,7 +107,7 @@ Events.subscribe(PlayerInteractEvent.class)
```


### [`Scheduler`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/Scheduler.java)
### Scheduler
The scheduler class provides easy static access to the Bukkit Scheduler. All future methods return `CompletableFuture`s, allowing for easy use of callbacks and use of the Completion Stage API.

It also exposes asynchronous and synchronous `Executor` instances.
Expand Down Expand Up @@ -152,7 +151,7 @@ Scheduler.callAsync(() -> {
```


### [`Metadata`](https://github.com/lucko/helper/tree/master/helper/src/main/java/me/lucko/helper/metadata)
### Metadata
helper provides an alternate system to the Bukkit Metadata API. The main benefits over Bukkit are the use of generic types and automatically expiring, weak or soft values.

The metadata API can be easily integrated with the Event system, thanks to some default filters.
Expand Down Expand Up @@ -223,7 +222,7 @@ Events.subscribe(PlayerDeathEvent.class)
Unlike Bukkit's system, metadata will be removed automatically when a player leaves the server, meaning you need-not worry about creating accidental memory leaks from left over metadata. The API also supports attaching metadata to blocks, worlds and other entities.


### [`Messenger`](https://github.com/lucko/helper/tree/master/helper/src/main/java/me/lucko/helper/messaging)
### Messenger
helper provides a Messenger abstraction utility, which consists of a few key classes.

* [`Messenger`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/messaging/Messenger.java) - an object which manages messaging Channels
Expand Down Expand Up @@ -284,7 +283,7 @@ public class GlobalMessengerPlugin extends ExtendedJavaPlugin {
You can either integrate messenger into your own existing messaging system (using [`AbstractMessenger`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/messaging/AbstractMessenger.java), or, use **helper-redis**, which implements Messenger using Jedis and the Redis PubSub system.


### [`Commands`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/Commands.java)
### Commands
helper provides a very simple command abstraction, designed to reduce some of the boilerplate needed when writing simple commands.

It doesn't have support for automatic argument parsing, sub commands, or anything like that. It's only purpose is removing the bloat from writing simple commands.
Expand Down Expand Up @@ -340,7 +339,7 @@ Commands.create()
```


### [`Scoreboard`](https://github.com/lucko/helper/tree/master/helper/src/main/java/me/lucko/helper/scoreboard)
### Scoreboard
helper includes a thread safe scoreboard system, allowing you to easily setup & update custom teams and objectives. It is written directly at the packet level, meaning it can be safely used from asynchronous tasks.

For example....
Expand Down Expand Up @@ -380,7 +379,7 @@ Scheduler.runTaskRepeatingAsync(() -> {
```


### [`GUI`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/menu/Gui.java)
### GUI
helper provides a highly adaptable and flexible GUI abstraction class.

All you have to do is extend `Gui` and override the `#redraw` method.
Expand Down Expand Up @@ -466,7 +465,7 @@ The GUI class also provides a number of methods which allow you to
* Create automatically paginated views in a "dictionary" style


### [`Menu Scheming`](https://github.com/lucko/helper/tree/master/helper/src/main/java/me/lucko/helper/menu/scheme)
### Menu Scheming
MenuScheme allows you to easily apply layouts to GUIs without having to think about slot ids.
```java
@Override
Expand Down Expand Up @@ -509,7 +508,7 @@ public void redraw() {
```


### [`Plugin Annotations`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/plugin/ap/Plugin.java)
### Plugin Annotations
With helper, you can automagically create the standard `plugin.yml` files at compile time using annotation processing.

Simply annotate your main class with `@Plugin` and fill in the name and version. The processor will take care of the rest!
Expand Down Expand Up @@ -540,7 +539,7 @@ public class MyPlugin extends JavaPlugin {
```


### [`Maven Annotations`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/maven/MavenLibrary.java)
### Maven Annotations
helper includes a system which allows you to magically download dependencies for your plugins at runtime.

This means you don't have to shade MBs of libraries into your jar. It's as simple as adding an annotation to your plugins class.
Expand All @@ -561,7 +560,7 @@ public class ExamplePlugin extends JavaPlugin {
```


### [`Terminables`](https://github.com/lucko/helper/tree/master/helper/src/main/java/me/lucko/helper/terminable)
### Terminables
Terminables are a way to easily cleanup active objects in plugins when a shutdown or reset is needed.

The system consists of a few key interfaces.
Expand Down Expand Up @@ -616,7 +615,7 @@ public class DemoPlugin extends ExtendedJavaPlugin {
}
```

### [`Serialization`](https://github.com/lucko/helper/tree/master/helper/src/main/java/me/lucko/helper/serialize)
### Serialization
helper provides a few classes with are useful when trying to serialize plugin data. It makes use of Google's GSON to convert from Java Objects to JSON.

* [`Position`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/serialize/Position.java) - similar to Bukkit's location, but without pitch/yaw
Expand Down Expand Up @@ -689,7 +688,7 @@ gsonHandler.save(ImmutableList.of("some key", "some value"));
```


### [`Bungee Messaging`](https://github.com/lucko/helper/blob/master/helper/src/main/java/me/lucko/helper/messaging/bungee/BungeeMessaging.java)
### Bungee Messaging
helper provides a wrapper class for the BungeeCord Plugin Messaging API, providing callbacks to read response data.

It handles the messaging channels behind the scenes and simply runs the provided callback when the data is returned.
Expand Down
24 changes: 24 additions & 0 deletions docs/javadoc/helper-mongo/allclasses-frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Sun Sep 24 18:09:31 BST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (helper-mongo 1.0.1 API)</title>
<meta name="date" content="2017-09-24">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="me/lucko/helper/mongo/HelperMongo.html" title="interface in me.lucko.helper.mongo" target="classFrame"><span class="interfaceName">HelperMongo</span></a></li>
<li><a href="me/lucko/helper/mongo/MongoDatabaseCredentials.html" title="class in me.lucko.helper.mongo" target="classFrame">MongoDatabaseCredentials</a></li>
<li><a href="me/lucko/helper/mongo/plugin/MongoPlugin.html" title="class in me.lucko.helper.mongo.plugin" target="classFrame">MongoPlugin</a></li>
<li><a href="me/lucko/helper/mongo/MongoProvider.html" title="interface in me.lucko.helper.mongo" target="classFrame"><span class="interfaceName">MongoProvider</span></a></li>
<li><a href="me/lucko/helper/mongo/plugin/MongoWrapper.html" title="class in me.lucko.helper.mongo.plugin" target="classFrame">MongoWrapper</a></li>
</ul>
</div>
</body>
</html>
24 changes: 24 additions & 0 deletions docs/javadoc/helper-mongo/allclasses-noframe.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Sun Sep 24 18:09:31 BST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (helper-mongo 1.0.1 API)</title>
<meta name="date" content="2017-09-24">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="me/lucko/helper/mongo/HelperMongo.html" title="interface in me.lucko.helper.mongo"><span class="interfaceName">HelperMongo</span></a></li>
<li><a href="me/lucko/helper/mongo/MongoDatabaseCredentials.html" title="class in me.lucko.helper.mongo">MongoDatabaseCredentials</a></li>
<li><a href="me/lucko/helper/mongo/plugin/MongoPlugin.html" title="class in me.lucko.helper.mongo.plugin">MongoPlugin</a></li>
<li><a href="me/lucko/helper/mongo/MongoProvider.html" title="interface in me.lucko.helper.mongo"><span class="interfaceName">MongoProvider</span></a></li>
<li><a href="me/lucko/helper/mongo/plugin/MongoWrapper.html" title="class in me.lucko.helper.mongo.plugin">MongoWrapper</a></li>
</ul>
</div>
</body>
</html>
126 changes: 126 additions & 0 deletions docs/javadoc/helper-mongo/constant-values.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_121) on Sun Sep 24 18:09:30 BST 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Constant Field Values (helper-mongo 1.0.1 API)</title>
<meta name="date" content="2017-09-24">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Constant Field Values (helper-mongo 1.0.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
<h2 title="Contents">Contents</h2>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>
Loading

0 comments on commit fcbf72c

Please sign in to comment.