From a08b21ba4fb699decb187e4d1ad0495ae7510aac Mon Sep 17 00:00:00 2001 From: CavariuX Date: Sun, 19 Apr 2015 15:13:26 -0500 Subject: [PATCH] docs --- doc/allclasses-frame.html | 21 + doc/allclasses-noframe.html | 21 + doc/constant-values.html | 124 ++ doc/deprecated-list.html | 153 ++ doc/help-doc.html | 229 +++ doc/index-files/index-1.html | 131 ++ doc/index-files/index-10.html | 153 ++ doc/index-files/index-11.html | 143 ++ doc/index-files/index-12.html | 167 ++ doc/index-files/index-13.html | 247 +++ doc/index-files/index-14.html | 157 ++ doc/index-files/index-15.html | 149 ++ doc/index-files/index-16.html | 155 ++ doc/index-files/index-17.html | 131 ++ doc/index-files/index-2.html | 147 ++ doc/index-files/index-3.html | 139 ++ doc/index-files/index-4.html | 131 ++ doc/index-files/index-5.html | 131 ++ doc/index-files/index-6.html | 131 ++ doc/index-files/index-7.html | 131 ++ doc/index-files/index-8.html | 135 ++ doc/index-files/index-9.html | 171 +++ doc/index.html | 74 + doc/overview-frame.html | 22 + doc/overview-summary.html | 139 ++ doc/overview-tree.html | 140 ++ doc/package-list | 2 + doc/script.js | 30 + doc/serialized-form.html | 213 +++ doc/stylesheet.css | 574 +++++++ doc/tk/cavariux/twitchirc/Chat/Channel.html | 550 +++++++ doc/tk/cavariux/twitchirc/Chat/User.html | 318 ++++ .../twitchirc/Chat/class-use/Channel.html | 219 +++ .../twitchirc/Chat/class-use/User.html | 179 +++ .../twitchirc/Chat/package-frame.html | 21 + .../twitchirc/Chat/package-summary.html | 150 ++ .../cavariux/twitchirc/Chat/package-tree.html | 138 ++ .../cavariux/twitchirc/Chat/package-use.html | 185 +++ doc/tk/cavariux/twitchirc/Core/TwitchBot.html | 505 ++++++ .../twitchirc/Core/class-use/TwitchBot.html | 165 ++ .../twitchirc/Core/package-frame.html | 20 + .../twitchirc/Core/package-summary.html | 144 ++ .../cavariux/twitchirc/Core/package-tree.html | 137 ++ .../cavariux/twitchirc/Core/package-use.html | 159 ++ doc/tk/cavariux/twitchirc/Json/JsonArray.html | 1041 +++++++++++++ .../twitchirc/Json/JsonObject.Member.html | 303 ++++ .../cavariux/twitchirc/Json/JsonObject.html | 1352 +++++++++++++++++ doc/tk/cavariux/twitchirc/Json/JsonValue.html | 1002 ++++++++++++ .../twitchirc/Json/ParseException.html | 317 ++++ .../twitchirc/Json/class-use/JsonArray.html | 325 ++++ .../Json/class-use/JsonObject.Member.html | 166 ++ .../twitchirc/Json/class-use/JsonObject.html | 334 ++++ .../twitchirc/Json/class-use/JsonValue.html | 333 ++++ .../Json/class-use/ParseException.html | 124 ++ .../twitchirc/Json/package-frame.html | 27 + .../twitchirc/Json/package-summary.html | 180 +++ .../cavariux/twitchirc/Json/package-tree.html | 156 ++ .../cavariux/twitchirc/Json/package-use.html | 175 +++ 58 files changed, 13016 insertions(+) create mode 100644 doc/allclasses-frame.html create mode 100644 doc/allclasses-noframe.html create mode 100644 doc/constant-values.html create mode 100644 doc/deprecated-list.html create mode 100644 doc/help-doc.html create mode 100644 doc/index-files/index-1.html create mode 100644 doc/index-files/index-10.html create mode 100644 doc/index-files/index-11.html create mode 100644 doc/index-files/index-12.html create mode 100644 doc/index-files/index-13.html create mode 100644 doc/index-files/index-14.html create mode 100644 doc/index-files/index-15.html create mode 100644 doc/index-files/index-16.html create mode 100644 doc/index-files/index-17.html create mode 100644 doc/index-files/index-2.html create mode 100644 doc/index-files/index-3.html create mode 100644 doc/index-files/index-4.html create mode 100644 doc/index-files/index-5.html create mode 100644 doc/index-files/index-6.html create mode 100644 doc/index-files/index-7.html create mode 100644 doc/index-files/index-8.html create mode 100644 doc/index-files/index-9.html create mode 100644 doc/index.html create mode 100644 doc/overview-frame.html create mode 100644 doc/overview-summary.html create mode 100644 doc/overview-tree.html create mode 100644 doc/package-list create mode 100644 doc/script.js create mode 100644 doc/serialized-form.html create mode 100644 doc/stylesheet.css create mode 100644 doc/tk/cavariux/twitchirc/Chat/Channel.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/User.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/class-use/Channel.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/class-use/User.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/package-frame.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/package-summary.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/package-tree.html create mode 100644 doc/tk/cavariux/twitchirc/Chat/package-use.html create mode 100644 doc/tk/cavariux/twitchirc/Core/TwitchBot.html create mode 100644 doc/tk/cavariux/twitchirc/Core/class-use/TwitchBot.html create mode 100644 doc/tk/cavariux/twitchirc/Core/package-frame.html create mode 100644 doc/tk/cavariux/twitchirc/Core/package-summary.html create mode 100644 doc/tk/cavariux/twitchirc/Core/package-tree.html create mode 100644 doc/tk/cavariux/twitchirc/Core/package-use.html create mode 100644 doc/tk/cavariux/twitchirc/Json/JsonArray.html create mode 100644 doc/tk/cavariux/twitchirc/Json/JsonObject.Member.html create mode 100644 doc/tk/cavariux/twitchirc/Json/JsonObject.html create mode 100644 doc/tk/cavariux/twitchirc/Json/JsonValue.html create mode 100644 doc/tk/cavariux/twitchirc/Json/ParseException.html create mode 100644 doc/tk/cavariux/twitchirc/Json/class-use/JsonArray.html create mode 100644 doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.Member.html create mode 100644 doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.html create mode 100644 doc/tk/cavariux/twitchirc/Json/class-use/JsonValue.html create mode 100644 doc/tk/cavariux/twitchirc/Json/class-use/ParseException.html create mode 100644 doc/tk/cavariux/twitchirc/Json/package-frame.html create mode 100644 doc/tk/cavariux/twitchirc/Json/package-summary.html create mode 100644 doc/tk/cavariux/twitchirc/Json/package-tree.html create mode 100644 doc/tk/cavariux/twitchirc/Json/package-use.html diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html new file mode 100644 index 0000000..c1e167d --- /dev/null +++ b/doc/allclasses-frame.html @@ -0,0 +1,21 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html new file mode 100644 index 0000000..f1bc325 --- /dev/null +++ b/doc/allclasses-noframe.html @@ -0,0 +1,21 @@ + + + + + +All Classes + + + + + +

All Classes

+
+ +
+ + diff --git a/doc/constant-values.html b/doc/constant-values.html new file mode 100644 index 0000000..abb0e79 --- /dev/null +++ b/doc/constant-values.html @@ -0,0 +1,124 @@ + + + + + +Constant Field Values + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Constant Field Values

+

Contents

+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html new file mode 100644 index 0000000..342925f --- /dev/null +++ b/doc/deprecated-list.html @@ -0,0 +1,153 @@ + + + + + +Deprecated List + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Deprecated API

+

Contents

+ +
+
+ + + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/help-doc.html b/doc/help-doc.html new file mode 100644 index 0000000..1031bbb --- /dev/null +++ b/doc/help-doc.html @@ -0,0 +1,229 @@ + + + + + +API Help + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html new file mode 100644 index 0000000..bbe07d2 --- /dev/null +++ b/doc/index-files/index-1.html @@ -0,0 +1,131 @@ + + + + + +B-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

B

+
+
ban(User) - Method in class Channel
+
+
Ban a user of the channel (Need Mod)
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html new file mode 100644 index 0000000..c8374c8 --- /dev/null +++ b/doc/index-files/index-10.html @@ -0,0 +1,153 @@ + + + + + +T-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

T

+
+
timeOut(User, int) - Method in class Channel
+
+
Timeout a player on the chat, useful for clearing spam (Need Mod)
+
+
tk.cavariux.twitchirc.Chat - package tk.cavariux.twitchirc.Chat
+
 
+
tk.cavariux.twitchirc.Core - package tk.cavariux.twitchirc.Core
+
 
+
toString() - Method in class Channel
+
+
Deprecated. +
No need of using this, only in small cases
+
+
+
toString() - Method in class User
+
+
Deprecated. +
No need on using it, if you put the User on a string it will change automatically
+
+
+
TwitchBot - Class in tk.cavariux.twitchirc.Core
+
+
The main object to start making your bot
+
+
TwitchBot() - Constructor for class TwitchBot
+
 
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html new file mode 100644 index 0000000..e2ca5e3 --- /dev/null +++ b/doc/index-files/index-11.html @@ -0,0 +1,143 @@ + + + + + +U-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

U

+
+
unBan(User) - Method in class Channel
+
+
Unban a user from the chat (Need Mod)
+
+
unhost() - Method in class Channel
+
+
Unhost the hosted channel (Need Streamer/Editor)
+
+
User - Class in tk.cavariux.twitchirc.Chat
+
+
The user object
+
+
User(String) - Constructor for class User
+
+
The constructor for a user.
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html new file mode 100644 index 0000000..c96b66b --- /dev/null +++ b/doc/index-files/index-12.html @@ -0,0 +1,167 @@ + + + + + +R-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E F G H I J N P R S T U V W  + + +

R

+
+
r9kbeta() - Method in class Channel
+
+
Turn on the r9kbeta feature on Twitch (Need Mod)
+
+
r9kbetaOff() - Method in class Channel
+
+
Turns off the r9kbeta feature on Twitch (Need Mod)
+
+
readFrom(Reader) - Static method in class JsonArray
+
+
Reads a JSON array from the given reader.
+
+
readFrom(String) - Static method in class JsonArray
+
+
Reads a JSON array from the given string.
+
+
readFrom(Reader) - Static method in class JsonObject
+
+
Reads a JSON object from the given reader.
+
+
readFrom(String) - Static method in class JsonObject
+
+
Reads a JSON object from the given string.
+
+
readFrom(Reader) - Static method in class JsonValue
+
+
Reads a JSON value from the given reader.
+
+
readFrom(String) - Static method in class JsonValue
+
+
Reads a JSON value from the given string.
+
+
remove(int) - Method in class JsonArray
+
+
Removes the element at the specified index from this array.
+
+
remove(String) - Method in class JsonObject
+
+
Removes a member with the specified name from this object.
+
+
+A B C E F G H I J N P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html new file mode 100644 index 0000000..1d8fc1f --- /dev/null +++ b/doc/index-files/index-13.html @@ -0,0 +1,247 @@ + + + + + +S-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E F G H I J N P R S T U V W  + + +

S

+
+
sendMessage(String, Channel) - Method in class TwitchBot
+
+
Send a message to a channel on Twitch (Don't need to be on that channel)
+
+
sendMessage(int, Channel) - Method in class TwitchBot
+
+
A sendMessage variation with an int
+
+
sendRawMessage(String) - Method in class TwitchBot
+
+
This method is used if you want to send a command to the IRC server, not commontly used
+
+
sendRawMessage(int) - Method in class TwitchBot
+
+
An int variation of the sendRawMessage(String)
+
+
set(int, int) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the JSON representation of + the specified int value.
+
+
set(int, long) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the JSON representation of + the specified long value.
+
+
set(int, float) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the JSON representation of + the specified float value.
+
+
set(int, double) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the JSON representation of + the specified double value.
+
+
set(int, boolean) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the JSON representation of + the specified boolean value.
+
+
set(int, String) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the JSON representation of + the specified string.
+
+
set(int, JsonValue) - Method in class JsonArray
+
+
Replaces the element at the specified position in this array with the specified JSON value.
+
+
set(String, int) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the JSON representation of the + specified int value.
+
+
set(String, long) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the JSON representation of the + specified long value.
+
+
set(String, float) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the JSON representation of the + specified float value.
+
+
set(String, double) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the JSON representation of the + specified double value.
+
+
set(String, boolean) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the JSON representation of the + specified boolean value.
+
+
set(String, String) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the JSON representation of the + specified string.
+
+
set(String, JsonValue) - Method in class JsonObject
+
+
Sets the value of the member with the specified name to the specified JSON value.
+
+
setOauth_Key(String) - Method in class TwitchBot
+
+
Set the "password" that the connect method will use.
+
+
setUsername(String) - Method in class TwitchBot
+
+
Set the username that the connect method will use
+
+
size() - Method in class JsonArray
+
+
Returns the number of elements in this array.
+
+
size() - Method in class JsonObject
+
+
Returns the number of members (i.e. name/value pairs) in this object.
+
+
slowMode(int) - Method in class Channel
+
+
Slowmode on the chat (Need Mod)
+
+
slowOff() - Method in class Channel
+
+
Turns off the slowmode (Need Mod)
+
+
start() - Method in class TwitchBot
+
+
Starts the full mechanism of the bot, this is the last method to be called
+
+
subscribersOnly() - Method in class Channel
+
+
Turns the chat on subscribers only (Need Mod) (The channel needs partner with twitch)
+
+
suscribersOnlyOff() - Method in class Channel
+
+
Turns off the chat only room (Need Mod)
+
+
+A B C E F G H I J N P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html new file mode 100644 index 0000000..3a2dab8 --- /dev/null +++ b/doc/index-files/index-14.html @@ -0,0 +1,157 @@ + + + + + +T-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E F G H I J N P R S T U V W  + + +

T

+
+
timeOut(User, int) - Method in class Channel
+
+
Timeout a player on the chat, usefull for clearing spam (Need Mod)
+
+
tk.cavariux.twitchirc.Chat - package tk.cavariux.twitchirc.Chat
+
 
+
tk.cavariux.twitchirc.Core - package tk.cavariux.twitchirc.Core
+
 
+
tk.cavariux.twitchirc.Json - package tk.cavariux.twitchirc.Json
+
 
+
toString() - Method in class Channel
+
+
Gets the name of the Channel (Automatic if you only put the Channel object)
+
+
toString() - Method in class User
+
 
+
toString() - Method in class JsonValue
+
+
Returns the JSON string for this value in its minimal form, without any additional whitespace.
+
+
TRUE - Static variable in class JsonValue
+
+
Represents the JSON literal true.
+
+
TwitchBot - Class in tk.cavariux.twitchirc.Core
+
+
The main object to start making your bot
+
+
TwitchBot() - Constructor for class TwitchBot
+
 
+
+A B C E F G H I J N P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html new file mode 100644 index 0000000..3b35150 --- /dev/null +++ b/doc/index-files/index-15.html @@ -0,0 +1,149 @@ + + + + + +U-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E F G H I J N P R S T U V W  + + +

U

+
+
unBan(User) - Method in class Channel
+
+
Unban a user from the chat (Need Mod)
+
+
unhost() - Method in class Channel
+
+
Unhost the hosted channel (Need Streamer/Editor)
+
+
unmodifiableArray(JsonArray) - Static method in class JsonArray
+
+
Returns an unmodifiable wrapper for the specified JsonArray.
+
+
unmodifiableObject(JsonObject) - Static method in class JsonObject
+
+
Returns an unmodifiable JsonObject for the specified one.
+
+
User - Class in tk.cavariux.twitchirc.Chat
+
+
The user object
+
+
User(String) - Constructor for class User
+
 
+
+A B C E F G H I J N P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html new file mode 100644 index 0000000..17e7912 --- /dev/null +++ b/doc/index-files/index-16.html @@ -0,0 +1,155 @@ + + + + + +V-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E F G H I J N P R S T U V W  + + +

V

+
+
valueOf(int) - Static method in class JsonValue
+
+
Returns a JsonValue instance that represents the given int value.
+
+
valueOf(long) - Static method in class JsonValue
+
+
Returns a JsonValue instance that represents the given long value.
+
+
valueOf(float) - Static method in class JsonValue
+
+
Returns a JsonValue instance that represents the given float value.
+
+
valueOf(double) - Static method in class JsonValue
+
+
Returns a JsonValue instance that represents the given double value.
+
+
valueOf(String) - Static method in class JsonValue
+
+
Returns a JsonValue instance that represents the given string.
+
+
valueOf(boolean) - Static method in class JsonValue
+
+
Returns a JsonValue instance that represents the given boolean value.
+
+
values() - Method in class JsonArray
+
+
Returns a list of the values in this array in document order.
+
+
+A B C E F G H I J N P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html new file mode 100644 index 0000000..76a4870 --- /dev/null +++ b/doc/index-files/index-17.html @@ -0,0 +1,131 @@ + + + + + +W-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
A B C E F G H I J N P R S T U V W  + + +

W

+
+
writeTo(Writer) - Method in class JsonValue
+
+
Writes the JSON representation for this object to the given writer.
+
+
+A B C E F G H I J N P R S T U V W 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html new file mode 100644 index 0000000..11d2d1d --- /dev/null +++ b/doc/index-files/index-2.html @@ -0,0 +1,147 @@ + + + + + +C-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

C

+
+
Channel - Class in tk.cavariux.twitchirc.Chat
+
+
The channel object
+
+
Channel(String, TwitchBot) - Constructor for class Channel
+
+
The constructor of the channel object
+
+
clearChat() - Method in class Channel
+
+
Clears the chat useful for clearing spam (Need Mod)
+
+
comercial() - Method in class Channel
+
+
Put a comercial on air for 30sec (Need Streamer/Editor)
+
+
connect() - Method in class TwitchBot
+
+
The connect method alouds you to connect to the IRC servers on twitch
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html new file mode 100644 index 0000000..1b97a2e --- /dev/null +++ b/doc/index-files/index-3.html @@ -0,0 +1,139 @@ + + + + + +G-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

G

+
+
getVersion() - Method in class TwitchBot
+
+
Get the version of the TwitchIRC lib
+
+
getViewers() - Method in class Channel
+
+
Get the currently viewers (This method is on beta so it may not be optimized)
+
+
getWriter() - Method in class TwitchBot
+
+
No need to use this dev things
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html new file mode 100644 index 0000000..3a709c3 --- /dev/null +++ b/doc/index-files/index-4.html @@ -0,0 +1,131 @@ + + + + + +H-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

H

+
+
host(Channel) - Method in class Channel
+
+
Host a channel (Need Streamer/Editor)
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html new file mode 100644 index 0000000..eeda2ee --- /dev/null +++ b/doc/index-files/index-5.html @@ -0,0 +1,131 @@ + + + + + +I-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

I

+
+
isOp(Channel) - Method in class User
+
+
Check if the User is op (May bug out some times) (Method in beta may not be optimized)
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html new file mode 100644 index 0000000..684cf52 --- /dev/null +++ b/doc/index-files/index-6.html @@ -0,0 +1,131 @@ + + + + + +J-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

J

+
+
joinChannel(String) - Method in class TwitchBot
+
+
The method to join an IRC channel on Twitch
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html new file mode 100644 index 0000000..b2adfb5 --- /dev/null +++ b/doc/index-files/index-7.html @@ -0,0 +1,131 @@ + + + + + +P-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

P

+
+
partChannel(String) - Method in class TwitchBot
+
+
Leaves the channel you want
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html new file mode 100644 index 0000000..a80cf1c --- /dev/null +++ b/doc/index-files/index-8.html @@ -0,0 +1,135 @@ + + + + + +R-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

R

+
+
r9kbeta() - Method in class Channel
+
+
Turn on the r9kbeta feature on Twitch (Need Mod)
+
+
r9kbetaOff() - Method in class Channel
+
+
Turns off the r9kbeta feature on Twitch (Need Mod)
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html new file mode 100644 index 0000000..3f5e1e7 --- /dev/null +++ b/doc/index-files/index-9.html @@ -0,0 +1,171 @@ + + + + + +S-Index + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
B C G H I J P R S T U  + + +

S

+
+
sendMessage(String, Channel) - Method in class TwitchBot
+
+
Send a message to a channel on Twitch (Don't need to be on that channel)
+
+
sendMessage(int, Channel) - Method in class TwitchBot
+
+
A sendMessage variation with an int
+
+
sendRawMessage(String) - Method in class TwitchBot
+
+
This method is used if you want to send a command to the IRC server, not commontly used
+
+
sendRawMessage(int) - Method in class TwitchBot
+
+
An int variation of the sendRawMessage(String)
+
+
setOauth_Key(String) - Method in class TwitchBot
+
+
Set the "password" that the connect method will use.
+
+
setUsername(String) - Method in class TwitchBot
+
+
Set the username that the connect method will use
+
+
slowMode(int) - Method in class Channel
+
+
Slowmode on the chat (Need Mod)
+
+
slowOff() - Method in class Channel
+
+
Turns off the slowmode (Need Mod)
+
+
start() - Method in class TwitchBot
+
+
Starts the full mechanism of the bot, this is the last method to be called
+
+
subscribersOnly() - Method in class Channel
+
+
Turns the chat on subscribers only (Need Mod) (The channel needs partner with twitch)
+
+
suscribersOnlyOff() - Method in class Channel
+
+
Turns off the chat only room (Need Mod)
+
+
+B C G H I J P R S T U 
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..2ceb235 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,74 @@ + + + + + +Generated Documentation (Untitled) + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/doc/overview-frame.html b/doc/overview-frame.html new file mode 100644 index 0000000..0006790 --- /dev/null +++ b/doc/overview-frame.html @@ -0,0 +1,22 @@ + + + + + +Overview List + + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/doc/overview-summary.html b/doc/overview-summary.html new file mode 100644 index 0000000..326ded2 --- /dev/null +++ b/doc/overview-summary.html @@ -0,0 +1,139 @@ + + + + + +Overview + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + +
Packages 
PackageDescription
tk.cavariux.twitchirc.Chat 
tk.cavariux.twitchirc.Core 
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/overview-tree.html b/doc/overview-tree.html new file mode 100644 index 0000000..066899e --- /dev/null +++ b/doc/overview-tree.html @@ -0,0 +1,140 @@ + + + + + +Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/package-list b/doc/package-list new file mode 100644 index 0000000..d98a7d5 --- /dev/null +++ b/doc/package-list @@ -0,0 +1,2 @@ +tk.cavariux.twitchirc.Chat +tk.cavariux.twitchirc.Core diff --git a/doc/script.js b/doc/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/doc/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/doc/serialized-form.html b/doc/serialized-form.html new file mode 100644 index 0000000..2483c3e --- /dev/null +++ b/doc/serialized-form.html @@ -0,0 +1,213 @@ + + + + + +Serialized Form + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Serialized Form

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/stylesheet.css b/doc/stylesheet.css new file mode 100644 index 0000000..cebb4fd --- /dev/null +++ b/doc/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; + width:100%; +} +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, +.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/doc/tk/cavariux/twitchirc/Chat/Channel.html b/doc/tk/cavariux/twitchirc/Chat/Channel.html new file mode 100644 index 0000000..5ddbc8a --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/Channel.html @@ -0,0 +1,550 @@ + + + + + +Channel + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
tk.cavariux.twitchirc.Chat
+

Class Channel

+
+
+ +
+
    +
  • +
    +
    +
    public class Channel
+extends Object
    +
    The channel object
    +
    +
    Version:
    +
    1.2-alpha
    +
    Author:
    +
    Leonardo Mariscal
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Channel(String channel, + TwitchBot bot) +
      The constructor of the channel object
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      voidban(User user) +
      Ban a user of the channel (Need Mod)
      +
      voidclearChat() +
      Clears the chat useful for clearing spam (Need Mod)
      +
      voidcomercial() +
      Put a comercial on air for 30sec (Need Streamer/Editor)
      +
      String[]getViewers() +
      Get the currently viewers (This method is on beta so it may not be optimized)
      +
      voidhost(Channel channel) +
      Host a channel (Need Streamer/Editor)
      +
      voidr9kbeta() +
      Turn on the r9kbeta feature on Twitch (Need Mod)
      +
      voidr9kbetaOff() +
      Turns off the r9kbeta feature on Twitch (Need Mod)
      +
      voidslowMode(int sec) +
      Slowmode on the chat (Need Mod)
      +
      voidslowOff() +
      Turns off the slowmode (Need Mod)
      +
      voidsubscribersOnly() +
      Turns the chat on subscribers only (Need Mod) (The channel needs partner with twitch)
      +
      voidsuscribersOnlyOff() +
      Turns off the chat only room (Need Mod)
      +
      voidtimeOut(User user, + int time) +
      Timeout a player on the chat, useful for clearing spam (Need Mod)
      +
      StringtoString() +
      Deprecated.  +
      No need of using this, only in small cases
      +
      +
      voidunBan(User user) +
      Unban a user from the chat (Need Mod)
      +
      voidunhost() +
      Unhost the hosted channel (Need Streamer/Editor)
      +
      +
        +
      • + + +

        Methods inherited from class Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Channel

        +
        public Channel(String channel,
+               TwitchBot bot)
        +
        The constructor of the channel object
        +
        +
        Parameters:
        +
        channel - The name of the Channel
        +
        bot - The bot that will be linked with
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        @Deprecated
+public final String toString()
        +
        Deprecated. No need of using this, only in small cases
        +
        Gets the name of the Channel (Automatic if you only put the Channel object)
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        • +
      + + + +
        +
      • +

        ban

        +
        public final void ban(User user)
        +
        Ban a user of the channel (Need Mod)
        +
        +
        Parameters:
        +
        user - The user that will be banned
        +
        +
        • +
      + + + +
        +
      • +

        timeOut

        +
        public final void timeOut(User user,
+                          int time)
        +
        Timeout a player on the chat, useful for clearing spam (Need Mod)
        +
        +
        Parameters:
        +
        user - The user that will be timeout
        +
        time - The time that will get timeout (Sometimes twitch change this)
        +
        +
        • +
      + + + +
        +
      • +

        unBan

        +
        public final void unBan(User user)
        +
        Unban a user from the chat (Need Mod)
        +
        +
        Parameters:
        +
        user - The user that will get unban
        +
        +
        • +
      + + + +
        +
      • +

        slowMode

        +
        public final void slowMode(int sec)
        +
        Slowmode on the chat (Need Mod)
        +
        +
        Parameters:
        +
        sec - seconds of cooldown between messages of a user
        +
        +
        • +
      + + + +
        +
      • +

        slowOff

        +
        public final void slowOff()
        +
        Turns off the slowmode (Need Mod)
        +
        • +
      + + + +
        +
      • +

        subscribersOnly

        +
        public final void subscribersOnly()
        +
        Turns the chat on subscribers only (Need Mod) (The channel needs partner with twitch)
        +
        • +
      + + + +
        +
      • +

        suscribersOnlyOff

        +
        public final void suscribersOnlyOff()
        +
        Turns off the chat only room (Need Mod)
        +
        • +
      + + + +
        +
      • +

        clearChat

        +
        public final void clearChat()
        +
        Clears the chat useful for clearing spam (Need Mod)
        +
        • +
      + + + +
        +
      • +

        r9kbeta

        +
        public final void r9kbeta()
        +
        Turn on the r9kbeta feature on Twitch (Need Mod)
        +
        • +
      + + + +
        +
      • +

        r9kbetaOff

        +
        public final void r9kbetaOff()
        +
        Turns off the r9kbeta feature on Twitch (Need Mod)
        +
        • +
      + + + +
        +
      • +

        comercial

        +
        public final void comercial()
        +
        Put a comercial on air for 30sec (Need Streamer/Editor)
        +
        • +
      + + + +
        +
      • +

        host

        +
        public final void host(Channel channel)
        +
        Host a channel (Need Streamer/Editor)
        +
        +
        Parameters:
        +
        channel - The target of the host
        +
        +
        • +
      + + + +
        +
      • +

        unhost

        +
        public final void unhost()
        +
        Unhost the hosted channel (Need Streamer/Editor)
        +
        • +
      + + + +
        +
      • +

        getViewers

        +
        public final String[] getViewers()
        +
        Get the currently viewers (This method is on beta so it may not be optimized)
        +
        +
        Returns:
        +
        A String[] with all the current viewers
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Chat/User.html b/doc/tk/cavariux/twitchirc/Chat/User.html new file mode 100644 index 0000000..5ad48b5 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/User.html @@ -0,0 +1,318 @@ + + + + + +User + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
tk.cavariux.twitchirc.Chat
+

Class User

+
+
+ +
+
    +
  • +
    +
    +
    public class User
+extends Object
    +
    The user object
    +
    +
    Version:
    +
    1.2-alpha
    +
    Author:
    +
    Leonardo Mariscal
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      User(String user) +
      The constructor for a user.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and TypeMethod and Description
      booleanisOp(Channel channel) +
      Check if the User is op (May bug out some times) (Method in beta may not be optimized)
      +
      StringtoString() +
      Deprecated.  +
      No need on using it, if you put the User on a string it will change automatically
      +
      +
      +
        +
      • + + +

        Methods inherited from class Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        User

        +
        public User(String user)
        +
        The constructor for a user.
        +
        +
        Parameters:
        +
        user - The name of the User
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toString

        +
        @Deprecated
+public String toString()
        +
        Deprecated. No need on using it, if you put the User on a string it will change automatically
        +
        Change the User into a String
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        • +
      + + + +
        +
      • +

        isOp

        +
        public final boolean isOp(Channel channel)
        +
        Check if the User is op (May bug out some times) (Method in beta may not be optimized)
        +
        +
        Parameters:
        +
        channel - The channel to check
        +
        Returns:
        +
        A boolean if its op returns true
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Chat/class-use/Channel.html b/doc/tk/cavariux/twitchirc/Chat/class-use/Channel.html new file mode 100644 index 0000000..79cc050 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/class-use/Channel.html @@ -0,0 +1,219 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Chat.Channel + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Chat.Channel

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Chat/class-use/User.html b/doc/tk/cavariux/twitchirc/Chat/class-use/User.html new file mode 100644 index 0000000..6784f58 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/class-use/User.html @@ -0,0 +1,179 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Chat.User + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Chat.User

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Chat/package-frame.html b/doc/tk/cavariux/twitchirc/Chat/package-frame.html new file mode 100644 index 0000000..e816909 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/package-frame.html @@ -0,0 +1,21 @@ + + + + + +tk.cavariux.twitchirc.Chat + + + + + +

tk.cavariux.twitchirc.Chat

+
+

Classes

+ +
+ + diff --git a/doc/tk/cavariux/twitchirc/Chat/package-summary.html b/doc/tk/cavariux/twitchirc/Chat/package-summary.html new file mode 100644 index 0000000..8178c5b --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/package-summary.html @@ -0,0 +1,150 @@ + + + + + +tk.cavariux.twitchirc.Chat + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package tk.cavariux.twitchirc.Chat

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Chat/package-tree.html b/doc/tk/cavariux/twitchirc/Chat/package-tree.html new file mode 100644 index 0000000..ba806cd --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/package-tree.html @@ -0,0 +1,138 @@ + + + + + +tk.cavariux.twitchirc.Chat Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package tk.cavariux.twitchirc.Chat

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Chat/package-use.html b/doc/tk/cavariux/twitchirc/Chat/package-use.html new file mode 100644 index 0000000..e9d5876 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Chat/package-use.html @@ -0,0 +1,185 @@ + + + + + +Uses of Package tk.cavariux.twitchirc.Chat + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
tk.cavariux.twitchirc.Chat

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Core/TwitchBot.html b/doc/tk/cavariux/twitchirc/Core/TwitchBot.html new file mode 100644 index 0000000..d744515 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Core/TwitchBot.html @@ -0,0 +1,505 @@ + + + + + +TwitchBot + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
tk.cavariux.twitchirc.Core
+

Class TwitchBot

+
+
+ +
+
    +
  • +
    +
    +
    public class TwitchBot
+extends Object
    +
    The main object to start making your bot
    +
    +
    Version:
    +
    1.2-alpha
    +
    Author:
    +
    CavariuX
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      TwitchBot() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidconnect() +
      The connect method alouds you to connect to the IRC servers on twitch
      +
      StringgetVersion() +
      Get the version of the TwitchIRC lib
      +
      BufferedWritergetWriter() +
      No need to use this dev things
      +
      ChanneljoinChannel(String channel) +
      The method to join an IRC channel on Twitch
      +
      voidpartChannel(String channel) +
      Leaves the channel you want
      +
      voidsendMessage(int message, + Channel channel) +
      A sendMessage variation with an int
      +
      voidsendMessage(String message, + Channel channel) +
      Send a message to a channel on Twitch (Don't need to be on that channel)
      +
      voidsendRawMessage(int message) +
      An int variation of the sendRawMessage(String)
      +
      voidsendRawMessage(String message) +
      This method is used if you want to send a command to the IRC server, not commontly used
      +
      voidsetOauth_Key(String oauth_key) +
      Set the "password" that the connect method will use.
      +
      voidsetUsername(String username) +
      Set the username that the connect method will use
      +
      voidstart() +
      Starts the full mechanism of the bot, this is the last method to be called
      +
      +
        +
      • + + +

        Methods inherited from class Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TwitchBot

        +
        public TwitchBot()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        connect

        +
        public void connect()
        +
        The connect method alouds you to connect to the IRC servers on twitch
        +
        • +
      + + + +
        +
      • +

        setUsername

        +
        public final void setUsername(String username)
        +
        Set the username that the connect method will use
        +
        +
        Parameters:
        +
        username - Needs your Twitch Username to connect
        +
        +
        • +
      + + + +
        +
      • +

        setOauth_Key

        +
        public final void setOauth_Key(String oauth_key)
        +
        Set the "password" that the connect method will use.
        +
        +
        Parameters:
        +
        oauth_key - To get this key go to the TwitchApps and get it on the TMI section
        +
        +
        • +
      + + + +
        +
      • +

        sendRawMessage

        +
        public void sendRawMessage(String message)
        +
        This method is used if you want to send a command to the IRC server, not commontly used
        +
        +
        Parameters:
        +
        message - the command you will sent
        +
        +
        • +
      + + + +
        +
      • +

        sendRawMessage

        +
        public void sendRawMessage(int message)
        +
        An int variation of the sendRawMessage(String)
        +
        +
        Parameters:
        +
        message - the command you will sent
        +
        +
        • +
      + + + +
        +
      • +

        sendMessage

        +
        public void sendMessage(String message,
+                        Channel channel)
        +
        Send a message to a channel on Twitch (Don't need to be on that channel)
        +
        +
        Parameters:
        +
        message - The message that will be sent
        +
        channel - The channel where the message will be sent
        +
        +
        • +
      + + + +
        +
      • +

        sendMessage

        +
        public void sendMessage(int message,
+                        Channel channel)
        +
        A sendMessage variation with an int
        +
        +
        Parameters:
        +
        message - The message that will be sent
        +
        channel - channel The channel where the message will be sent
        +
        +
        • +
      + + + +
        +
      • +

        joinChannel

        +
        public final Channel joinChannel(String channel)
        +
        The method to join an IRC channel on Twitch
        +
        +
        Parameters:
        +
        channel - The channel name
        +
        Returns:
        +
        You can get the channel you just created
        +
        +
        • +
      + + + +
        +
      • +

        partChannel

        +
        public final void partChannel(String channel)
        +
        Leaves the channel you want
        +
        +
        Parameters:
        +
        channel - The channel you want to leave
        +
        +
        • +
      + + + +
        +
      • +

        getWriter

        +
        public final BufferedWriter getWriter()
        +
        No need to use this dev things
        +
        +
        Returns:
        +
        a BufferedWrtier
        +
        +
        • +
      + + + +
        +
      • +

        start

        +
        public final void start()
        +
        Starts the full mechanism of the bot, this is the last method to be called
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public final String getVersion()
        +
        Get the version of the TwitchIRC lib
        +
        +
        Returns:
        +
        the version of the TwitchIRC lib
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Core/class-use/TwitchBot.html b/doc/tk/cavariux/twitchirc/Core/class-use/TwitchBot.html new file mode 100644 index 0000000..6899237 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Core/class-use/TwitchBot.html @@ -0,0 +1,165 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Core.TwitchBot + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Core.TwitchBot

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Core/package-frame.html b/doc/tk/cavariux/twitchirc/Core/package-frame.html new file mode 100644 index 0000000..be25c8b --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Core/package-frame.html @@ -0,0 +1,20 @@ + + + + + +tk.cavariux.twitchirc.Core + + + + + +

tk.cavariux.twitchirc.Core

+
+

Classes

+ +
+ + diff --git a/doc/tk/cavariux/twitchirc/Core/package-summary.html b/doc/tk/cavariux/twitchirc/Core/package-summary.html new file mode 100644 index 0000000..2491883 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Core/package-summary.html @@ -0,0 +1,144 @@ + + + + + +tk.cavariux.twitchirc.Core + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package tk.cavariux.twitchirc.Core

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Core/package-tree.html b/doc/tk/cavariux/twitchirc/Core/package-tree.html new file mode 100644 index 0000000..4929a3d --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Core/package-tree.html @@ -0,0 +1,137 @@ + + + + + +tk.cavariux.twitchirc.Core Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package tk.cavariux.twitchirc.Core

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Core/package-use.html b/doc/tk/cavariux/twitchirc/Core/package-use.html new file mode 100644 index 0000000..e0ff266 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Core/package-use.html @@ -0,0 +1,159 @@ + + + + + +Uses of Package tk.cavariux.twitchirc.Core + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
tk.cavariux.twitchirc.Core

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/JsonArray.html b/doc/tk/cavariux/twitchirc/Json/JsonArray.html new file mode 100644 index 0000000..4ce4695 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/JsonArray.html @@ -0,0 +1,1041 @@ + + + + + +JsonArray + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
tk.cavariux.twitchirc.Json
+

Class JsonArray

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Iterable<JsonValue>
    +
    +
    +
    +
    public class JsonArray
+extends JsonValue
+implements Iterable<JsonValue>
    +
    Represents a JSON array, i.e. an ordered collection of JSON values. +

    + Elements can be added using the add(...) methods which accept instances of + JsonValue, strings, primitive numbers, and boolean values. To replace an element of an + array, use the set(int, ...) methods. +

    +

    + Elements can be accessed by their index using get(int). This class also supports + iterating over the elements in document order using an iterator() or an enhanced for + loop: +

    + + 
    + for( JsonValue value : jsonArray ) {
+   ...
+ }
+
    +

    + An equivalent List can be obtained from the method values(). +

    +

    + Note that this class is not thread-safe. If multiple threads access a + JsonArray instance concurrently, while at least one of these threads modifies the + contents of this array, access to the instance must be synchronized externally. Failure to do so + may lead to an inconsistent state. +

    +

    + This class is not supposed to be extended by clients. +

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      JsonArray() +
      Creates a new empty JsonArray.
      +
      JsonArray(JsonArray array) +
      Creates a new JsonArray with the contents of the specified JSON array.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      JsonArrayadd(boolean value) +
      Appends the JSON representation of the specified boolean value to the end of this + array.
      +
      JsonArrayadd(double value) +
      Appends the JSON representation of the specified double value to the end of this + array.
      +
      JsonArrayadd(float value) +
      Appends the JSON representation of the specified float value to the end of this + array.
      +
      JsonArrayadd(int value) +
      Appends the JSON representation of the specified int value to the end of this + array.
      +
      JsonArrayadd(JsonValue value) +
      Appends the specified JSON value to the end of this array.
      +
      JsonArrayadd(long value) +
      Appends the JSON representation of the specified long value to the end of this + array.
      +
      JsonArrayadd(String value) +
      Appends the JSON representation of the specified string to the end of this array.
      +
      JsonArrayasArray() +
      Returns this JSON value as JsonArray, assuming that this value represents a JSON + array.
      +
      booleanequals(Object object) +
      Indicates whether some other object is "equal to" this one according to the contract specified + in Object.equals(Object).
      +
      JsonValueget(int index) +
      Returns the value of the element at the specified position in this array.
      +
      inthashCode() 
      booleanisArray() +
      Detects whether this value represents a JSON array.
      +
      booleanisEmpty() +
      Returns true if this array contains no elements.
      +
      Iterator<JsonValue>iterator() +
      Returns an iterator over the values of this array in document order.
      +
      static JsonArrayreadFrom(Reader reader) +
      Reads a JSON array from the given reader.
      +
      static JsonArrayreadFrom(String string) +
      Reads a JSON array from the given string.
      +
      JsonArrayremove(int index) +
      Removes the element at the specified index from this array.
      +
      JsonArrayset(int index, + boolean value) +
      Replaces the element at the specified position in this array with the JSON representation of + the specified boolean value.
      +
      JsonArrayset(int index, + double value) +
      Replaces the element at the specified position in this array with the JSON representation of + the specified double value.
      +
      JsonArrayset(int index, + float value) +
      Replaces the element at the specified position in this array with the JSON representation of + the specified float value.
      +
      JsonArrayset(int index, + int value) +
      Replaces the element at the specified position in this array with the JSON representation of + the specified int value.
      +
      JsonArrayset(int index, + JsonValue value) +
      Replaces the element at the specified position in this array with the specified JSON value.
      +
      JsonArrayset(int index, + long value) +
      Replaces the element at the specified position in this array with the JSON representation of + the specified long value.
      +
      JsonArrayset(int index, + String value) +
      Replaces the element at the specified position in this array with the JSON representation of + the specified string.
      +
      intsize() +
      Returns the number of elements in this array.
      +
      static JsonArrayunmodifiableArray(JsonArray array) +
      Returns an unmodifiable wrapper for the specified JsonArray.
      +
      List<JsonValue>values() +
      Returns a list of the values in this array in document order.
      +
      + +
        +
      • + + +

        Methods inherited from class Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JsonArray

        +
        public JsonArray()
        +
        Creates a new empty JsonArray.
        +
        • +
      + + + +
        +
      • +

        JsonArray

        +
        public JsonArray(JsonArray array)
        +
        Creates a new JsonArray with the contents of the specified JSON array.
        +
        +
        Parameters:
        +
        array - the JsonArray to get the initial contents from, must not be null
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readFrom

        +
        public static JsonArray readFrom(Reader reader)
+                          throws IOException
        +
        Reads a JSON array from the given reader. +

        + Characters are read in chunks and buffered internally, therefore wrapping an existing reader in + an additional BufferedReader does not improve reading + performance. +

        +
        +
        Parameters:
        +
        reader - the reader to read the JSON array from
        +
        Returns:
        +
        the JSON array that has been read
        +
        Throws:
        +
        IOException - if an I/O error occurs in the reader
        +
        ParseException - if the input is not valid JSON
        +
        UnsupportedOperationException - if the input does not contain a JSON array
        +
        +
        • +
      + + + +
        +
      • +

        readFrom

        +
        public static JsonArray readFrom(String string)
        +
        Reads a JSON array from the given string.
        +
        +
        Parameters:
        +
        string - the string that contains the JSON array
        +
        Returns:
        +
        the JSON array that has been read
        +
        Throws:
        +
        ParseException - if the input is not valid JSON
        +
        UnsupportedOperationException - if the input does not contain a JSON array
        +
        +
        • +
      + + + +
        +
      • +

        unmodifiableArray

        +
        public static JsonArray unmodifiableArray(JsonArray array)
        +
        Returns an unmodifiable wrapper for the specified JsonArray. This method allows to provide + read-only access to a JsonArray. +

        + The returned JsonArray is backed by the given array and reflects subsequent changes. Attempts + to modify the returned JsonArray result in an UnsupportedOperationException. +

        +
        +
        Parameters:
        +
        array - the JsonArray for which an unmodifiable JsonArray is to be returned
        +
        Returns:
        +
        an unmodifiable view of the specified JsonArray
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(int value)
        +
        Appends the JSON representation of the specified int value to the end of this + array.
        +
        +
        Parameters:
        +
        value - the value to add to the array
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(long value)
        +
        Appends the JSON representation of the specified long value to the end of this + array.
        +
        +
        Parameters:
        +
        value - the value to add to the array
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(float value)
        +
        Appends the JSON representation of the specified float value to the end of this + array.
        +
        +
        Parameters:
        +
        value - the value to add to the array
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(double value)
        +
        Appends the JSON representation of the specified double value to the end of this + array.
        +
        +
        Parameters:
        +
        value - the value to add to the array
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(boolean value)
        +
        Appends the JSON representation of the specified boolean value to the end of this + array.
        +
        +
        Parameters:
        +
        value - the value to add to the array
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(String value)
        +
        Appends the JSON representation of the specified string to the end of this array.
        +
        +
        Parameters:
        +
        value - the string to add to the array
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonArray add(JsonValue value)
        +
        Appends the specified JSON value to the end of this array.
        +
        +
        Parameters:
        +
        value - the JsonValue to add to the array, must not be null
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     int value)
        +
        Replaces the element at the specified position in this array with the JSON representation of + the specified int value.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the value to be stored at the specified array position
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     long value)
        +
        Replaces the element at the specified position in this array with the JSON representation of + the specified long value.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the value to be stored at the specified array position
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     float value)
        +
        Replaces the element at the specified position in this array with the JSON representation of + the specified float value.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the value to be stored at the specified array position
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     double value)
        +
        Replaces the element at the specified position in this array with the JSON representation of + the specified double value.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the value to be stored at the specified array position
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     boolean value)
        +
        Replaces the element at the specified position in this array with the JSON representation of + the specified boolean value.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the value to be stored at the specified array position
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     String value)
        +
        Replaces the element at the specified position in this array with the JSON representation of + the specified string.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the string to be stored at the specified array position
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonArray set(int index,
+                     JsonValue value)
        +
        Replaces the element at the specified position in this array with the specified JSON value.
        +
        +
        Parameters:
        +
        index - the index of the array element to replace
        +
        value - the value to be stored at the specified array position, must not be null
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public JsonArray remove(int index)
        +
        Removes the element at the specified index from this array.
        +
        +
        Parameters:
        +
        index - the index of the element to remove
        +
        Returns:
        +
        the array itself, to enable method chaining
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of elements in this array.
        +
        +
        Returns:
        +
        the number of elements in this array
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true if this array contains no elements.
        +
        +
        Returns:
        +
        true if this array contains no elements
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public JsonValue get(int index)
        +
        Returns the value of the element at the specified position in this array.
        +
        +
        Parameters:
        +
        index - the index of the array element to return
        +
        Returns:
        +
        the value of the element at the specified position
        +
        Throws:
        +
        IndexOutOfBoundsException - if the index is out of range, i.e. index < 0 or + index >= size
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public List<JsonValue> values()
        +
        Returns a list of the values in this array in document order. The returned list is backed by + this array and will reflect subsequent changes. It cannot be used to modify this array. + Attempts to modify the returned list will result in an exception.
        +
        +
        Returns:
        +
        a list of the values in this array
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public Iterator<JsonValue> iterator()
        +
        Returns an iterator over the values of this array in document order. The returned iterator + cannot be used to modify this array.
        +
        +
        Specified by:
        +
        iterator in interface Iterable<JsonValue>
        +
        Returns:
        +
        an iterator over the values of this array
        +
        +
        • +
      + + + +
        +
      • +

        isArray

        +
        public boolean isArray()
        +
        Description copied from class: JsonValue
        +
        Detects whether this value represents a JSON array. If this is the case, this value is an + instance of JsonArray.
        +
        +
        Overrides:
        +
        isArray in class JsonValue
        +
        Returns:
        +
        true if this value is an instance of JsonArray
        +
        +
        • +
      + + + +
        +
      • +

        asArray

        +
        public JsonArray asArray()
        +
        Description copied from class: JsonValue
        +
        Returns this JSON value as JsonArray, assuming that this value represents a JSON + array. If this is not the case, an exception is thrown.
        +
        +
        Overrides:
        +
        asArray in class JsonValue
        +
        Returns:
        +
        a JSONArray for this value
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class JsonValue
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(Object object)
        +
        Description copied from class: JsonValue
        +
        Indicates whether some other object is "equal to" this one according to the contract specified + in Object.equals(Object). +

        + Two JsonValues are considered equal if and only if they represent the same JSON text. As a + consequence, two given JsonObjects may be different even though they contain the same set of + names with the same values, but in a different order. +

        +
        +
        Overrides:
        +
        equals in class JsonValue
        +
        Parameters:
        +
        object - the reference object with which to compare
        +
        Returns:
        +
        true if this object is the same as the object argument; false otherwise
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/JsonObject.Member.html b/doc/tk/cavariux/twitchirc/Json/JsonObject.Member.html new file mode 100644 index 0000000..1bba57f --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/JsonObject.Member.html @@ -0,0 +1,303 @@ + + + + + +JsonObject.Member + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
tk.cavariux.twitchirc.Json
+

Class JsonObject.Member

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    JsonObject
    +
    +
    +
    +
    public static class JsonObject.Member
+extends Object
    +
    Represents a member of a JSON object, i.e. a pair of name and value.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      booleanequals(Object obj) 
      StringgetName() +
      Returns the name of this member.
      +
      JsonValuegetValue() +
      Returns the value of this member.
      +
      inthashCode() 
      +
        +
      • + + +

        Methods inherited from class Object

        +getClass, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        public String getName()
        +
        Returns the name of this member.
        +
        +
        Returns:
        +
        the name of this member, never null
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public JsonValue getValue()
        +
        Returns the value of this member.
        +
        +
        Returns:
        +
        the value of this member, never null
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(Object obj)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/JsonObject.html b/doc/tk/cavariux/twitchirc/Json/JsonObject.html new file mode 100644 index 0000000..ef2b6cb --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/JsonObject.html @@ -0,0 +1,1352 @@ + + + + + +JsonObject + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
tk.cavariux.twitchirc.Json
+

Class JsonObject

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Iterable<JsonObject.Member>
    +
    +
    +
    +
    public class JsonObject
+extends JsonValue
+implements Iterable<JsonObject.Member>
    +
    Represents a JSON object, i.e. an unordered set of name/value pairs, where the names are strings + and the values are JSON values. +

    + Members can be added using the add(String, ...) methods which accept instances of + JsonValue, strings, primitive numbers, and boolean values. To modify certain values of an + object, use the set(String, ...) methods. Please note that the add + methods are faster than set as they do not search for existing members. On the other + hand, the add methods do not prevent adding multiple members with the same name. + Duplicate names are discouraged but not prohibited by JSON. +

    +

    + Members can be accessed by their name using get(String). A list of all names can be + obtained from the method names(). This class also supports iterating over the members in + document order using an iterator() or an enhanced for loop: +

    + + 
    + for( Member member : jsonObject ) {
+   String name = member.getName();
+   JsonValue value = member.getValue();
+   ...
+ }
+
    +

    + Even though JSON objects are unordered by definition, instances of this class preserve the order + of members to allow processing in document order and to guarantee a predictable output. +

    +

    + Note that this class is not thread-safe. If multiple threads access a + JsonObject instance concurrently, while at least one of these threads modifies the + contents of this object, access to the instance must be synchronized externally. Failure to do so + may lead to an inconsistent state. +

    +

    + This class is not supposed to be extended by clients. +

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class JsonObject.Member +
      Represents a member of a JSON object, i.e. a pair of name and value.
      +
      +
      • +
    + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      JsonObject() +
      Creates a new empty JsonObject.
      +
      JsonObject(JsonObject object) +
      Creates a new JsonObject, initialized with the contents of the specified JSON object.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      JsonObjectadd(String name, + boolean value) +
      Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified boolean value.
      +
      JsonObjectadd(String name, + double value) +
      Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified double value.
      +
      JsonObjectadd(String name, + float value) +
      Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified float value.
      +
      JsonObjectadd(String name, + int value) +
      Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified int value.
      +
      JsonObjectadd(String name, + JsonValue value) +
      Appends a new member to the end of this object, with the specified name and the specified JSON + value.
      +
      JsonObjectadd(String name, + long value) +
      Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified long value.
      +
      JsonObjectadd(String name, + String value) +
      Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified string.
      +
      JsonObjectasObject() +
      Returns this JSON value as JsonObject, assuming that this value represents a JSON + object.
      +
      booleanequals(Object obj) +
      Indicates whether some other object is "equal to" this one according to the contract specified + in Object.equals(Object).
      +
      JsonValueget(String name) +
      Returns the value of the member with the specified name in this object.
      +
      booleangetBoolean(String name, + boolean defaultValue) +
      Returns the boolean value of the member with the specified name in this object.
      +
      doublegetDouble(String name, + double defaultValue) +
      Returns the double value of the member with the specified name in this object.
      +
      floatgetFloat(String name, + float defaultValue) +
      Returns the float value of the member with the specified name in this object.
      +
      intgetInt(String name, + int defaultValue) +
      Returns the int value of the member with the specified name in this object.
      +
      longgetLong(String name, + long defaultValue) +
      Returns the long value of the member with the specified name in this object.
      +
      StringgetString(String name, + String defaultValue) +
      Returns the String value of the member with the specified name in this object.
      +
      inthashCode() 
      booleanisEmpty() +
      Returns true if this object contains no members.
      +
      booleanisObject() +
      Detects whether this value represents a JSON object.
      +
      Iterator<JsonObject.Member>iterator() +
      Returns an iterator over the members of this object in document order.
      +
      List<String>names() +
      Returns a list of the names in this object in document order.
      +
      static JsonObjectreadFrom(Reader reader) +
      Reads a JSON object from the given reader.
      +
      static JsonObjectreadFrom(String string) +
      Reads a JSON object from the given string.
      +
      JsonObjectremove(String name) +
      Removes a member with the specified name from this object.
      +
      JsonObjectset(String name, + boolean value) +
      Sets the value of the member with the specified name to the JSON representation of the + specified boolean value.
      +
      JsonObjectset(String name, + double value) +
      Sets the value of the member with the specified name to the JSON representation of the + specified double value.
      +
      JsonObjectset(String name, + float value) +
      Sets the value of the member with the specified name to the JSON representation of the + specified float value.
      +
      JsonObjectset(String name, + int value) +
      Sets the value of the member with the specified name to the JSON representation of the + specified int value.
      +
      JsonObjectset(String name, + JsonValue value) +
      Sets the value of the member with the specified name to the specified JSON value.
      +
      JsonObjectset(String name, + long value) +
      Sets the value of the member with the specified name to the JSON representation of the + specified long value.
      +
      JsonObjectset(String name, + String value) +
      Sets the value of the member with the specified name to the JSON representation of the + specified string.
      +
      intsize() +
      Returns the number of members (i.e. name/value pairs) in this object.
      +
      static JsonObjectunmodifiableObject(JsonObject object) +
      Returns an unmodifiable JsonObject for the specified one.
      +
      + +
        +
      • + + +

        Methods inherited from class Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface Iterable

        +forEach, spliterator
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JsonObject

        +
        public JsonObject()
        +
        Creates a new empty JsonObject.
        +
        • +
      + + + +
        +
      • +

        JsonObject

        +
        public JsonObject(JsonObject object)
        +
        Creates a new JsonObject, initialized with the contents of the specified JSON object.
        +
        +
        Parameters:
        +
        object - the JSON object to get the initial contents from, must not be null
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readFrom

        +
        public static JsonObject readFrom(Reader reader)
+                           throws IOException
        +
        Reads a JSON object from the given reader. +

        + Characters are read in chunks and buffered internally, therefore wrapping an existing reader in + an additional BufferedReader does not improve reading + performance. +

        +
        +
        Parameters:
        +
        reader - the reader to read the JSON object from
        +
        Returns:
        +
        the JSON object that has been read
        +
        Throws:
        +
        IOException - if an I/O error occurs in the reader
        +
        ParseException - if the input is not valid JSON
        +
        UnsupportedOperationException - if the input does not contain a JSON object
        +
        +
        • +
      + + + +
        +
      • +

        readFrom

        +
        public static JsonObject readFrom(String string)
        +
        Reads a JSON object from the given string.
        +
        +
        Parameters:
        +
        string - the string that contains the JSON object
        +
        Returns:
        +
        the JSON object that has been read
        +
        Throws:
        +
        ParseException - if the input is not valid JSON
        +
        UnsupportedOperationException - if the input does not contain a JSON object
        +
        +
        • +
      + + + +
        +
      • +

        unmodifiableObject

        +
        public static JsonObject unmodifiableObject(JsonObject object)
        +
        Returns an unmodifiable JsonObject for the specified one. This method allows to provide + read-only access to a JsonObject. +

        + The returned JsonObject is backed by the given object and reflect changes that happen to it. + Attempts to modify the returned JsonObject result in an + UnsupportedOperationException. +

        +
        +
        Parameters:
        +
        object - the JsonObject for which an unmodifiable JsonObject is to be returned
        +
        Returns:
        +
        an unmodifiable view of the specified JsonObject
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      int value)
        +
        Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified int value. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      long value)
        +
        Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified long value. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      float value)
        +
        Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified float value. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      double value)
        +
        Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified double value. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      boolean value)
        +
        Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified boolean value. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      String value)
        +
        Appends a new member to the end of this object, with the specified name and the JSON + representation of the specified string. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        add

        +
        public JsonObject add(String name,
+                      JsonValue value)
        +
        Appends a new member to the end of this object, with the specified name and the specified JSON + value. +

        + This method does not prevent duplicate names. Calling this method with a name + that already exists in the object will append another member with the same name. In order to + replace existing members, use the method set(name, value) instead. However, + add is much faster than set (because it does not need to + search for existing members). Therefore add should be preferred when constructing new + objects. +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add, must not be null
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      int value)
        +
        Sets the value of the member with the specified name to the JSON representation of the + specified int value. If this object does not contain a member with this name, a + new member is added at the end of the object. If this object contains multiple members with + this name, only the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to replace
        +
        value - the value to set to the member
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      long value)
        +
        Sets the value of the member with the specified name to the JSON representation of the + specified long value. If this object does not contain a member with this name, a + new member is added at the end of the object. If this object contains multiple members with + this name, only the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to replace
        +
        value - the value to set to the member
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      float value)
        +
        Sets the value of the member with the specified name to the JSON representation of the + specified float value. If this object does not contain a member with this name, a + new member is added at the end of the object. If this object contains multiple members with + this name, only the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      double value)
        +
        Sets the value of the member with the specified name to the JSON representation of the + specified double value. If this object does not contain a member with this name, a + new member is added at the end of the object. If this object contains multiple members with + this name, only the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      boolean value)
        +
        Sets the value of the member with the specified name to the JSON representation of the + specified boolean value. If this object does not contain a member with this name, + a new member is added at the end of the object. If this object contains multiple members with + this name, only the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      String value)
        +
        Sets the value of the member with the specified name to the JSON representation of the + specified string. If this object does not contain a member with this name, a new member is + added at the end of the object. If this object contains multiple members with this name, only + the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        set

        +
        public JsonObject set(String name,
+                      JsonValue value)
        +
        Sets the value of the member with the specified name to the specified JSON value. If this + object does not contain a member with this name, a new member is added at the end of the + object. If this object contains multiple members with this name, only the last one is changed. +

        + This method should only be used to modify existing objects. To fill a new + object with members, the method add(name, value) should be preferred which is much + faster (as it does not need to search for existing members). +

        +
        +
        Parameters:
        +
        name - the name of the member to add
        +
        value - the value of the member to add, must not be null
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public JsonObject remove(String name)
        +
        Removes a member with the specified name from this object. If this object contains multiple + members with the given name, only the last one is removed. If this object does not contain a + member with the specified name, the object is not modified.
        +
        +
        Parameters:
        +
        name - the name of the member to remove
        +
        Returns:
        +
        the object itself, to enable method chaining
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public JsonValue get(String name)
        +
        Returns the value of the member with the specified name in this object. If this object contains + multiple members with the given name, this method will return the last one.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        Returns:
        +
        the value of the last member with the specified name, or null if this + object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        getInt

        +
        public int getInt(String name,
+                  int defaultValue)
        +
        Returns the int value of the member with the specified name in this object. If + this object does not contain a member with this name, the given default value is returned. If + this object contains multiple members with the given name, the last one will be picked. If this + member's value does not represent a JSON number or if it cannot be interpreted as Java + int, an exception is thrown.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        defaultValue - the value to be returned if the requested member is missing
        +
        Returns:
        +
        the value of the last member with the specified name, or the given default value if + this object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        getLong

        +
        public long getLong(String name,
+                    long defaultValue)
        +
        Returns the long value of the member with the specified name in this object. If + this object does not contain a member with this name, the given default value is returned. If + this object contains multiple members with the given name, the last one will be picked. If this + member's value does not represent a JSON number or if it cannot be interpreted as Java + long, an exception is thrown.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        defaultValue - the value to be returned if the requested member is missing
        +
        Returns:
        +
        the value of the last member with the specified name, or the given default value if + this object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        getFloat

        +
        public float getFloat(String name,
+                      float defaultValue)
        +
        Returns the float value of the member with the specified name in this object. If + this object does not contain a member with this name, the given default value is returned. If + this object contains multiple members with the given name, the last one will be picked. If this + member's value does not represent a JSON number or if it cannot be interpreted as Java + float, an exception is thrown.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        defaultValue - the value to be returned if the requested member is missing
        +
        Returns:
        +
        the value of the last member with the specified name, or the given default value if + this object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        getDouble

        +
        public double getDouble(String name,
+                        double defaultValue)
        +
        Returns the double value of the member with the specified name in this object. If + this object does not contain a member with this name, the given default value is returned. If + this object contains multiple members with the given name, the last one will be picked. If this + member's value does not represent a JSON number or if it cannot be interpreted as Java + double, an exception is thrown.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        defaultValue - the value to be returned if the requested member is missing
        +
        Returns:
        +
        the value of the last member with the specified name, or the given default value if + this object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        getBoolean

        +
        public boolean getBoolean(String name,
+                          boolean defaultValue)
        +
        Returns the boolean value of the member with the specified name in this object. If + this object does not contain a member with this name, the given default value is returned. If + this object contains multiple members with the given name, the last one will be picked. If this + member's value does not represent a JSON true or false value, an + exception is thrown.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        defaultValue - the value to be returned if the requested member is missing
        +
        Returns:
        +
        the value of the last member with the specified name, or the given default value if + this object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        getString

        +
        public String getString(String name,
+                        String defaultValue)
        +
        Returns the String value of the member with the specified name in this object. If + this object does not contain a member with this name, the given default value is returned. If + this object contains multiple members with the given name, the last one is picked. If this + member's value does not represent a JSON string, an exception is thrown.
        +
        +
        Parameters:
        +
        name - the name of the member whose value is to be returned
        +
        defaultValue - the value to be returned if the requested member is missing
        +
        Returns:
        +
        the value of the last member with the specified name, or the given default value if + this object does not contain a member with that name
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        Returns the number of members (i.e. name/value pairs) in this object.
        +
        +
        Returns:
        +
        the number of members in this object
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Returns true if this object contains no members.
        +
        +
        Returns:
        +
        true if this object contains no members
        +
        +
        • +
      + + + +
        +
      • +

        names

        +
        public List<String> names()
        +
        Returns a list of the names in this object in document order. The returned list is backed by + this object and will reflect subsequent changes. It cannot be used to modify this object. + Attempts to modify the returned list will result in an exception.
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public Iterator<JsonObject.Member> iterator()
        +
        Returns an iterator over the members of this object in document order. The returned iterator + cannot be used to modify this object.
        +
        +
        Specified by:
        +
        iterator in interface Iterable<JsonObject.Member>
        +
        Returns:
        +
        an iterator over the members of this object
        +
        +
        • +
      + + + +
        +
      • +

        isObject

        +
        public boolean isObject()
        +
        Description copied from class: JsonValue
        +
        Detects whether this value represents a JSON object. If this is the case, this value is an + instance of JsonObject.
        +
        +
        Overrides:
        +
        isObject in class JsonValue
        +
        Returns:
        +
        true if this value is an instance of JsonObject
        +
        +
        • +
      + + + +
        +
      • +

        asObject

        +
        public JsonObject asObject()
        +
        Description copied from class: JsonValue
        +
        Returns this JSON value as JsonObject, assuming that this value represents a JSON + object. If this is not the case, an exception is thrown.
        +
        +
        Overrides:
        +
        asObject in class JsonValue
        +
        Returns:
        +
        a JSONObject for this value
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class JsonValue
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(Object obj)
        +
        Description copied from class: JsonValue
        +
        Indicates whether some other object is "equal to" this one according to the contract specified + in Object.equals(Object). +

        + Two JsonValues are considered equal if and only if they represent the same JSON text. As a + consequence, two given JsonObjects may be different even though they contain the same set of + names with the same values, but in a different order. +

        +
        +
        Overrides:
        +
        equals in class JsonValue
        +
        Parameters:
        +
        obj - the reference object with which to compare
        +
        Returns:
        +
        true if this object is the same as the object argument; false otherwise
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/JsonValue.html b/doc/tk/cavariux/twitchirc/Json/JsonValue.html new file mode 100644 index 0000000..b6f79af --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/JsonValue.html @@ -0,0 +1,1002 @@ + + + + + +JsonValue + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
tk.cavariux.twitchirc.Json
+

Class JsonValue

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Direct Known Subclasses:
    +
    JsonArray, JsonObject
    +
    +
    +
    +
    public abstract class JsonValue
+extends Object
+implements Serializable
    +
    Represents a JSON value. This can be a JSON object, an array, + a number, a string, or one of the literals + true, false, and null. +

    + The literals true, false, and null are + represented by the constants TRUE, FALSE, and NULL. +

    +

    + JSON objects and arrays are represented by the subtypes + JsonObject and JsonArray. Instances of these types can be created using the + public constructors of these classes. +

    +

    + Instances that represent JSON numbers, strings and + boolean values can be created using the static factory methods + valueOf(String), valueOf(long), valueOf(double), etc. +

    +

    + In order to find out whether an instance of this class is of a certain type, the methods + isObject(), isArray(), isString(), isNumber() etc. can be + used. +

    +

    + If the type of a JSON value is known, the methods asObject(), asArray(), + asString(), asInt(), etc. can be used to get this value directly in the + appropriate target type. +

    +

    + This class is not supposed to be extended by clients. +

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static JsonValueFALSE +
      Represents the JSON literal false.
      +
      static JsonValueNULL +
      The JSON literal null.
      +
      static JsonValueTRUE +
      Represents the JSON literal true.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      JsonArrayasArray() +
      Returns this JSON value as JsonArray, assuming that this value represents a JSON + array.
      +
      booleanasBoolean() +
      Returns this JSON value as a boolean value, assuming that this value is either + true or false.
      +
      doubleasDouble() +
      Returns this JSON value as a double value, assuming that this value represents a + JSON number.
      +
      floatasFloat() +
      Returns this JSON value as a float value, assuming that this value represents a + JSON number.
      +
      intasInt() +
      Returns this JSON value as an int value, assuming that this value represents a + JSON number that can be interpreted as Java int.
      +
      longasLong() +
      Returns this JSON value as a long value, assuming that this value represents a + JSON number that can be interpreted as Java long.
      +
      JsonObjectasObject() +
      Returns this JSON value as JsonObject, assuming that this value represents a JSON + object.
      +
      StringasString() +
      Returns this JSON value as String, assuming that this value represents a JSON string.
      +
      booleanequals(Object object) +
      Indicates whether some other object is "equal to" this one according to the contract specified + in Object.equals(Object).
      +
      inthashCode() 
      booleanisArray() +
      Detects whether this value represents a JSON array.
      +
      booleanisBoolean() +
      Detects whether this value represents a boolean value.
      +
      booleanisFalse() +
      Detects whether this value represents the JSON literal false.
      +
      booleanisNull() +
      Detects whether this value represents the JSON literal null.
      +
      booleanisNumber() +
      Detects whether this value represents a JSON number.
      +
      booleanisObject() +
      Detects whether this value represents a JSON object.
      +
      booleanisString() +
      Detects whether this value represents a JSON string.
      +
      booleanisTrue() +
      Detects whether this value represents the JSON literal true.
      +
      static JsonValuereadFrom(Reader reader) +
      Reads a JSON value from the given reader.
      +
      static JsonValuereadFrom(String text) +
      Reads a JSON value from the given string.
      +
      StringtoString() +
      Returns the JSON string for this value in its minimal form, without any additional whitespace.
      +
      static JsonValuevalueOf(boolean value) +
      Returns a JsonValue instance that represents the given boolean value.
      +
      static JsonValuevalueOf(double value) +
      Returns a JsonValue instance that represents the given double value.
      +
      static JsonValuevalueOf(float value) +
      Returns a JsonValue instance that represents the given float value.
      +
      static JsonValuevalueOf(int value) +
      Returns a JsonValue instance that represents the given int value.
      +
      static JsonValuevalueOf(long value) +
      Returns a JsonValue instance that represents the given long value.
      +
      static JsonValuevalueOf(String string) +
      Returns a JsonValue instance that represents the given string.
      +
      voidwriteTo(Writer writer) +
      Writes the JSON representation for this object to the given writer.
      +
      +
        +
      • + + +

        Methods inherited from class Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        TRUE

        +
        public static final JsonValue TRUE
        +
        Represents the JSON literal true.
        +
        • +
      + + + +
        +
      • +

        FALSE

        +
        public static final JsonValue FALSE
        +
        Represents the JSON literal false.
        +
        • +
      + + + +
        +
      • +

        NULL

        +
        public static final JsonValue NULL
        +
        The JSON literal null.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        readFrom

        +
        public static JsonValue readFrom(Reader reader)
+                          throws IOException
        +
        Reads a JSON value from the given reader. +

        + Characters are read in chunks and buffered internally, therefore wrapping an existing reader in + an additional BufferedReader does not improve reading + performance. +

        +
        +
        Parameters:
        +
        reader - the reader to read the JSON value from
        +
        Returns:
        +
        the JSON value that has been read
        +
        Throws:
        +
        IOException - if an I/O error occurs in the reader
        +
        ParseException - if the input is not valid JSON
        +
        +
        • +
      + + + +
        +
      • +

        readFrom

        +
        public static JsonValue readFrom(String text)
        +
        Reads a JSON value from the given string.
        +
        +
        Parameters:
        +
        text - the string that contains the JSON value
        +
        Returns:
        +
        the JSON value that has been read
        +
        Throws:
        +
        ParseException - if the input is not valid JSON
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static JsonValue valueOf(int value)
        +
        Returns a JsonValue instance that represents the given int value.
        +
        +
        Parameters:
        +
        value - the value to get a JSON representation for
        +
        Returns:
        +
        a JSON value that represents the given value
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static JsonValue valueOf(long value)
        +
        Returns a JsonValue instance that represents the given long value.
        +
        +
        Parameters:
        +
        value - the value to get a JSON representation for
        +
        Returns:
        +
        a JSON value that represents the given value
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static JsonValue valueOf(float value)
        +
        Returns a JsonValue instance that represents the given float value.
        +
        +
        Parameters:
        +
        value - the value to get a JSON representation for
        +
        Returns:
        +
        a JSON value that represents the given value
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static JsonValue valueOf(double value)
        +
        Returns a JsonValue instance that represents the given double value.
        +
        +
        Parameters:
        +
        value - the value to get a JSON representation for
        +
        Returns:
        +
        a JSON value that represents the given value
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static JsonValue valueOf(String string)
        +
        Returns a JsonValue instance that represents the given string.
        +
        +
        Parameters:
        +
        string - the string to get a JSON representation for
        +
        Returns:
        +
        a JSON value that represents the given string
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static JsonValue valueOf(boolean value)
        +
        Returns a JsonValue instance that represents the given boolean value.
        +
        +
        Parameters:
        +
        value - the value to get a JSON representation for
        +
        Returns:
        +
        a JSON value that represents the given value
        +
        +
        • +
      + + + +
        +
      • +

        isObject

        +
        public boolean isObject()
        +
        Detects whether this value represents a JSON object. If this is the case, this value is an + instance of JsonObject.
        +
        +
        Returns:
        +
        true if this value is an instance of JsonObject
        +
        +
        • +
      + + + +
        +
      • +

        isArray

        +
        public boolean isArray()
        +
        Detects whether this value represents a JSON array. If this is the case, this value is an + instance of JsonArray.
        +
        +
        Returns:
        +
        true if this value is an instance of JsonArray
        +
        +
        • +
      + + + +
        +
      • +

        isNumber

        +
        public boolean isNumber()
        +
        Detects whether this value represents a JSON number.
        +
        +
        Returns:
        +
        true if this value represents a JSON number
        +
        +
        • +
      + + + +
        +
      • +

        isString

        +
        public boolean isString()
        +
        Detects whether this value represents a JSON string.
        +
        +
        Returns:
        +
        true if this value represents a JSON string
        +
        +
        • +
      + + + +
        +
      • +

        isBoolean

        +
        public boolean isBoolean()
        +
        Detects whether this value represents a boolean value.
        +
        +
        Returns:
        +
        true if this value represents either the JSON literal + true or false
        +
        +
        • +
      + + + +
        +
      • +

        isTrue

        +
        public boolean isTrue()
        +
        Detects whether this value represents the JSON literal true.
        +
        +
        Returns:
        +
        true if this value represents the JSON literal + true
        +
        +
        • +
      + + + +
        +
      • +

        isFalse

        +
        public boolean isFalse()
        +
        Detects whether this value represents the JSON literal false.
        +
        +
        Returns:
        +
        true if this value represents the JSON literal + false
        +
        +
        • +
      + + + +
        +
      • +

        isNull

        +
        public boolean isNull()
        +
        Detects whether this value represents the JSON literal null.
        +
        +
        Returns:
        +
        true if this value represents the JSON literal + null
        +
        +
        • +
      + + + +
        +
      • +

        asObject

        +
        public JsonObject asObject()
        +
        Returns this JSON value as JsonObject, assuming that this value represents a JSON + object. If this is not the case, an exception is thrown.
        +
        +
        Returns:
        +
        a JSONObject for this value
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON object
        +
        +
        • +
      + + + +
        +
      • +

        asArray

        +
        public JsonArray asArray()
        +
        Returns this JSON value as JsonArray, assuming that this value represents a JSON + array. If this is not the case, an exception is thrown.
        +
        +
        Returns:
        +
        a JSONArray for this value
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON array
        +
        +
        • +
      + + + +
        +
      • +

        asInt

        +
        public int asInt()
        +
        Returns this JSON value as an int value, assuming that this value represents a + JSON number that can be interpreted as Java int. If this is not the case, an + exception is thrown. +

        + To be interpreted as Java int, the JSON number must neither contain an exponent + nor a fraction part. Moreover, the number must be in the Integer range. +

        +
        +
        Returns:
        +
        this value as int
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON number
        +
        NumberFormatException - if this JSON number can not be interpreted as int value
        +
        +
        • +
      + + + +
        +
      • +

        asLong

        +
        public long asLong()
        +
        Returns this JSON value as a long value, assuming that this value represents a + JSON number that can be interpreted as Java long. If this is not the case, an + exception is thrown. +

        + To be interpreted as Java long, the JSON number must neither contain an exponent + nor a fraction part. Moreover, the number must be in the Long range. +

        +
        +
        Returns:
        +
        this value as long
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON number
        +
        NumberFormatException - if this JSON number can not be interpreted as long value
        +
        +
        • +
      + + + +
        +
      • +

        asFloat

        +
        public float asFloat()
        +
        Returns this JSON value as a float value, assuming that this value represents a + JSON number. If this is not the case, an exception is thrown. +

        + If the JSON number is out of the Float range, Float.POSITIVE_INFINITY or + Float.NEGATIVE_INFINITY is returned. +

        +
        +
        Returns:
        +
        this value as float
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON number
        +
        +
        • +
      + + + +
        +
      • +

        asDouble

        +
        public double asDouble()
        +
        Returns this JSON value as a double value, assuming that this value represents a + JSON number. If this is not the case, an exception is thrown. +

        + If the JSON number is out of the Double range, Double.POSITIVE_INFINITY or + Double.NEGATIVE_INFINITY is returned. +

        +
        +
        Returns:
        +
        this value as double
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON number
        +
        +
        • +
      + + + +
        +
      • +

        asString

        +
        public String asString()
        +
        Returns this JSON value as String, assuming that this value represents a JSON string. If this + is not the case, an exception is thrown.
        +
        +
        Returns:
        +
        the string represented by this value
        +
        Throws:
        +
        UnsupportedOperationException - if this value is not a JSON string
        +
        +
        • +
      + + + +
        +
      • +

        asBoolean

        +
        public boolean asBoolean()
        +
        Returns this JSON value as a boolean value, assuming that this value is either + true or false. If this is not the case, an exception is thrown.
        +
        +
        Returns:
        +
        this value as boolean
        +
        Throws:
        +
        UnsupportedOperationException - if this value is neither true or false
        +
        +
        • +
      + + + +
        +
      • +

        writeTo

        +
        public void writeTo(Writer writer)
+             throws IOException
        +
        Writes the JSON representation for this object to the given writer. +

        + Single elements are passed directly to the given writer. Therefore, if the writer is not + buffered, wrapping it in a BufferedWriter can drastically + improve writing performance. +

        +
        +
        Parameters:
        +
        writer - the writer to write this value to
        +
        Throws:
        +
        IOException - if an I/O error occurs in the writer
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Returns the JSON string for this value in its minimal form, without any additional whitespace. + The result is guaranteed to be a valid input for the method readFrom(String) and to + create a value that is equal to this object.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        Returns:
        +
        a JSON string that represents this value
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(Object object)
        +
        Indicates whether some other object is "equal to" this one according to the contract specified + in Object.equals(Object). +

        + Two JsonValues are considered equal if and only if they represent the same JSON text. As a + consequence, two given JsonObjects may be different even though they contain the same set of + names with the same values, but in a different order. +

        +
        +
        Overrides:
        +
        equals in class Object
        +
        Parameters:
        +
        object - the reference object with which to compare
        +
        Returns:
        +
        true if this object is the same as the object argument; false otherwise
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/ParseException.html b/doc/tk/cavariux/twitchirc/Json/ParseException.html new file mode 100644 index 0000000..4febbe7 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/ParseException.html @@ -0,0 +1,317 @@ + + + + + +ParseException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
tk.cavariux.twitchirc.Json
+

Class ParseException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    +
    public class ParseException
+extends RuntimeException
    +
    An unchecked exception to indicate that an input does not qualify as valid JSON.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intgetColumn() +
      Returns the index of the character at which the error occurred, relative to the line.
      +
      intgetLine() +
      Returns the number of the line in which the error occurred.
      +
      intgetOffset() +
      Returns the absolute index of the character at which the error occurred.
      +
      +
        +
      • + + +

        Methods inherited from class Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        • +
      +
        +
      • + + +

        Methods inherited from class Object

        +equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getOffset

        +
        public int getOffset()
        +
        Returns the absolute index of the character at which the error occurred. The + index of the first character of a document is 0.
        +
        +
        Returns:
        +
        the character offset at which the error occurred, will be >= 0
        +
        +
        • +
      + + + +
        +
      • +

        getLine

        +
        public int getLine()
        +
        Returns the number of the line in which the error occurred. The first line counts as 1.
        +
        +
        Returns:
        +
        the line in which the error occurred, will be >= 1
        +
        +
        • +
      + + + +
        +
      • +

        getColumn

        +
        public int getColumn()
        +
        Returns the index of the character at which the error occurred, relative to the line. The + index of the first character of a line is 0.
        +
        +
        Returns:
        +
        the column in which the error occurred, will be >= 0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/class-use/JsonArray.html b/doc/tk/cavariux/twitchirc/Json/class-use/JsonArray.html new file mode 100644 index 0000000..0ad3931 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/class-use/JsonArray.html @@ -0,0 +1,325 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Json.JsonArray + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Json.JsonArray

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.Member.html b/doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.Member.html new file mode 100644 index 0000000..4ec0069 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.Member.html @@ -0,0 +1,166 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Json.JsonObject.Member + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Json.JsonObject.Member

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.html b/doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.html new file mode 100644 index 0000000..36ed1ea --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/class-use/JsonObject.html @@ -0,0 +1,334 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Json.JsonObject + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Json.JsonObject

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/class-use/JsonValue.html b/doc/tk/cavariux/twitchirc/Json/class-use/JsonValue.html new file mode 100644 index 0000000..5fe59e0 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/class-use/JsonValue.html @@ -0,0 +1,333 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Json.JsonValue + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Json.JsonValue

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/class-use/ParseException.html b/doc/tk/cavariux/twitchirc/Json/class-use/ParseException.html new file mode 100644 index 0000000..09bbc5b --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/class-use/ParseException.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class tk.cavariux.twitchirc.Json.ParseException + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
tk.cavariux.twitchirc.Json.ParseException

+
+
No usage of tk.cavariux.twitchirc.Json.ParseException
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/package-frame.html b/doc/tk/cavariux/twitchirc/Json/package-frame.html new file mode 100644 index 0000000..192a09e --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/package-frame.html @@ -0,0 +1,27 @@ + + + + + +tk.cavariux.twitchirc.Json + + + + + +

tk.cavariux.twitchirc.Json

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/doc/tk/cavariux/twitchirc/Json/package-summary.html b/doc/tk/cavariux/twitchirc/Json/package-summary.html new file mode 100644 index 0000000..0d1486d --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/package-summary.html @@ -0,0 +1,180 @@ + + + + + +tk.cavariux.twitchirc.Json + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package tk.cavariux.twitchirc.Json

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/package-tree.html b/doc/tk/cavariux/twitchirc/Json/package-tree.html new file mode 100644 index 0000000..206f89a --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/package-tree.html @@ -0,0 +1,156 @@ + + + + + +tk.cavariux.twitchirc.Json Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package tk.cavariux.twitchirc.Json

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/tk/cavariux/twitchirc/Json/package-use.html b/doc/tk/cavariux/twitchirc/Json/package-use.html new file mode 100644 index 0000000..76f67d4 --- /dev/null +++ b/doc/tk/cavariux/twitchirc/Json/package-use.html @@ -0,0 +1,175 @@ + + + + + +Uses of Package tk.cavariux.twitchirc.Json + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
tk.cavariux.twitchirc.Json

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + +