A B C D E G H I K L M N O P R S T U V W

A

area() - Method in class net.wildfyre.posts.Comment

The Area in which this comment's Post was created.

asArea() - Method in exception net.wildfyre.descriptors.NoSuchEntityException

Downcasts the descriptor stored in this exception to an Area; fails if there is no descriptor stored or if the descriptor is of the wrong type.

asLogged() - Method in class net.wildfyre.users.User

This object, as a LoggedUser.

asUser() - Method in exception net.wildfyre.descriptors.NoSuchEntityException

Downcasts the descriptor stored in this exception to a User; fails if there is no descriptor stored or if the descriptor is of the wrong type.

author() - Method in class net.wildfyre.posts.Comment

The user who created this comment.

avatar - Variable in class net.wildfyre.users.User

avatar() - Method in class net.wildfyre.users.User

The avatar of this user: the raw URL written in a String object, as specified by the server.

avatarUrl() - Method in class net.wildfyre.users.User

The avatar of this user: a URL object is created and points to the location of the avatar picture.

B

bio - Variable in class net.wildfyre.users.User

bio() - Method in class net.wildfyre.users.User

The bio of this user.

C

CacheManager - Class in net.wildfyre.descriptors

Specifies for how long an object is kept in the local cache.

CacheManager() - Constructor for class net.wildfyre.descriptors.CacheManager

cacheManager() - Method in class net.wildfyre.descriptors.Descriptor

The Cache Manager that handles this object.

cacheManager() - Method in class net.wildfyre.posts.Draft

cacheManager() - Method in class net.wildfyre.posts.Post

cacheManager() - Method in class net.wildfyre.users.User

cacheManager() - Static method in class net.wildfyre.users.Users

The Cache Manager that handles Users.

canEdit() - Method in class net.wildfyre.users.LoggedUser

canEdit() - Method in class net.wildfyre.users.User

Can this user be edited?

clean() - Static method in class net.wildfyre.api.Internal

Cleans the cache -- that is, removes every object that is not valid anymore from it (see Descriptor.isValid()).

clean() - Static method in class net.wildfyre.users.Users

Cleans the internal cache, by removing the users that have expired.

clear() - Static method in class net.wildfyre.api.Internal

Fully clears the cache, but keeps the token.

clear() - Static method in class net.wildfyre.users.Users

The full User cache is cleared, no User is kept.

clear() - Method in class net.wildfyre.utils.LazyMap

Comment - Class in net.wildfyre.posts

connect(String, String) - Static method in class net.wildfyre.api.WildFyre

Connects to the server with the specified user.

connect(String) - Static method in class net.wildfyre.api.WildFyre

Connects to the server with the specified token.

containsKey(Object) - Method in class net.wildfyre.utils.LazyMap

containsValue(Object) - Method in class net.wildfyre.utils.LazyMap

created() - Method in class net.wildfyre.posts.Comment

When was this comment created?

D

DataType - Enum in net.wildfyre.http

delete() - Method in class net.wildfyre.posts.Draft

Descriptor - Class in net.wildfyre.descriptors

Descriptors represent the raw data from the server, and are used by the internal cache.

Descriptor() - Constructor for class net.wildfyre.descriptors.Descriptor

disconnect() - Static method in class net.wildfyre.api.WildFyre

Disconnects the API from the currently-logged-in user.

Draft - Class in net.wildfyre.posts

This class represents a Draft, which is essentially a builder for a Post.

Draft(String) - Constructor for class net.wildfyre.posts.Draft

Creates a new local Draft.

Draft(long, String) - Constructor for class net.wildfyre.posts.Draft

Creates a new Draft that points to a server-side Draft.

E

entrySet() - Method in class net.wildfyre.utils.LazyMap

equals(Object) - Method in class net.wildfyre.posts.Comment

equals(Object) - Method in class net.wildfyre.users.User

equals(Object) - Method in class net.wildfyre.utils.LazyMap

G

get() - Method in exception net.wildfyre.descriptors.NoSuchEntityException

The entity that does not exist server-side, or an empty optional if none was specified when creating this exception.

get(int) - Static method in class net.wildfyre.users.Users

Retrieves a user from the database.

get(Object) - Method in class net.wildfyre.utils.LazyMap

getCached(int) - Static method in class net.wildfyre.users.Users

Retrieves the user corresponding to a provided ID from the cache.

getCacheManager() - Static method in class net.wildfyre.posts.Draft

The cache manager that handles the Drafts.

getCacheManager() - Static method in class net.wildfyre.posts.Post

The cache manager used by Posts.

getID() - Method in class net.wildfyre.users.User

The ID of this user.

H

hashCode() - Method in class net.wildfyre.posts.Comment

hashCode() - Method in class net.wildfyre.users.User

hashCode() - Method in class net.wildfyre.utils.LazyMap

I

ID() - Method in class net.wildfyre.posts.Comment

The ID of this comment.

ID - Variable in class net.wildfyre.users.User

imageURL() - Method in class net.wildfyre.posts.Comment

The URL to the image of this comment.

init() - Static method in class net.wildfyre.api.Internal

Connects to the server & tries to access the logged-user's ID.

init() - Static method in class net.wildfyre.users.Users

Prepares this class to serve Users.

Internal - Class in net.wildfyre.api

This class represents the internals of the WildFyre Java Client Library.

Internal() - Constructor for class net.wildfyre.api.Internal

InvalidCredentialsException - Exception in net.wildfyre.utils

Thrown when the client tries to connect to the server, but the username or the password is incorrect.

InvalidCredentialsException(String, IssueInTransferException) - Constructor for exception net.wildfyre.utils.InvalidCredentialsException

InvalidJsonException - Exception in net.wildfyre.utils

This exception represents a problem that occurred because the JSON data provided contained an error.

isBanned - Variable in class net.wildfyre.users.User

isBanned() - Method in class net.wildfyre.users.User

Is this user banned?

isConnected() - Static method in class net.wildfyre.api.WildFyre

Is the user connected?

isEmpty() - Method in class net.wildfyre.utils.LazyMap

isInitialized() - Method in class net.wildfyre.utils.LazyMap

Is this object initialized?

isMyID(int) - Static method in class net.wildfyre.users.Users

isNew() - Method in class net.wildfyre.descriptors.Descriptor

Permits to know if this object was ever used before.

isPresent() - Method in exception net.wildfyre.descriptors.NoSuchEntityException

Was an entity specified when creating this exception?

isValid(long) - Method in class net.wildfyre.descriptors.Descriptor

Checks if this descriptor is still valid.

isValid() - Method in class net.wildfyre.descriptors.Descriptor

Checks if this descriptor is still valid.

K

keySet() - Method in class net.wildfyre.utils.LazyMap

L

LazyMap<K,V> - Class in net.wildfyre.utils

Represents a Map object that is lazily-instantiated.

LazyMap() - Constructor for class net.wildfyre.utils.LazyMap

Creates an empty object.

LazyMap(int) - Constructor for class net.wildfyre.utils.LazyMap

Creates an empty lazy map of specified capacity.

LazyMap(Map<K, V>) - Constructor for class net.wildfyre.utils.LazyMap

Creates a lazy map from the given map.

LazyMap(Collection<V>, Function<V, K>) - Constructor for class net.wildfyre.utils.LazyMap

Creates a lazy map from a given collection.

LoggedUser - Class in net.wildfyre.users

Represents the user you are logging-in with.

M

me() - Static method in class net.wildfyre.users.Users

The user that is connected to the API.

missingField(String, JsonValue) - Static method in exception net.wildfyre.utils.InvalidJsonException

Creates and returns an exception symbolizing that a required field was missing in some JSON data.

myID() - Static method in class net.wildfyre.users.Users

N

name - Variable in class net.wildfyre.users.User

name() - Method in class net.wildfyre.users.User

The name of this user.

net.wildfyre.api - package net.wildfyre.api

net.wildfyre.descriptors - package net.wildfyre.descriptors

net.wildfyre.http - package net.wildfyre.http

net.wildfyre.posts - package net.wildfyre.posts

net.wildfyre.users - package net.wildfyre.users

net.wildfyre.utils - package net.wildfyre.utils

NoSuchEntityException - Exception in net.wildfyre.descriptors

Exception thrown when the client queries an entity that does not exist server-side.

NoSuchEntityException(String) - Constructor for exception net.wildfyre.descriptors.NoSuchEntityException

Creates a NoSuchEntityException.

NoSuchEntityException(String, Descriptor) - Constructor for exception net.wildfyre.descriptors.NoSuchEntityException

Creates a NoSuchEntityException.

O

objectsExpireAfter() - Method in class net.wildfyre.descriptors.CacheManager

How long objects are kept in the cache.

optionalField(JsonObject, String) - Static method in exception net.wildfyre.utils.InvalidJsonException

Tries to access a field of a JSON object.

P

post() - Method in class net.wildfyre.posts.Comment

The Post in which this comment was created.

Post - Class in net.wildfyre.posts

Posts are the main objects in WildFyre.

Post(long, String) - Constructor for class net.wildfyre.posts.Post

Creates an empty Post object pointing to a Post on the server-side.

posts() - Method in class net.wildfyre.users.LoggedUser

Returns a Stream of every post created by the user in any Area.

postsList() - Method in class net.wildfyre.users.LoggedUser

Returns a list of the posts created by the user in any Area.

publish() - Method in class net.wildfyre.posts.Draft

Converts this Draft to a Post and publishes it.

put(K, V) - Method in class net.wildfyre.utils.LazyMap

putAll(Map<? extends K, ? extends V>) - Method in class net.wildfyre.utils.LazyMap

R

remove(Object) - Method in class net.wildfyre.utils.LazyMap

requestToken(String, String) - Static method in class net.wildfyre.api.Internal

Requests a token using a username and a password.

requireField(JsonObject, String) - Static method in exception net.wildfyre.utils.InvalidJsonException

Requires the existence of a field in a JSON object.

requireInitialized() - Method in class net.wildfyre.utils.LazyMap

Specifies that, in the case where this object is not initialized, it should be initialized now before further exploitation.

reset() - Static method in class net.wildfyre.api.Internal

Resets the API.

reset() - Static method in class net.wildfyre.users.Users

Resets the stored data of this class, that is dependent on the logged-in user.

S

save() - Method in class net.wildfyre.posts.Draft

Saves this Draft server-side.

set(String, String, String) - Method in class net.wildfyre.users.LoggedUser

Changes the username, bio or avatar of the user.

setAvatar(String) - Method in class net.wildfyre.users.LoggedUser

Sets this user's avatar.

setBio(String) - Method in class net.wildfyre.users.LoggedUser

Sets this user's bio.

setCantConnectHandler(Consumer<Request.CantConnectException>) - Static method in class net.wildfyre.api.Internal

Registers a handler for the case where the API cannot connect to the server.

setExpirationTime(long) - Method in class net.wildfyre.descriptors.CacheManager

Sets for how long objects are kept in the cache, before they are updated or deleted.

setIsAnonymous(boolean) - Method in class net.wildfyre.posts.Draft

setNoSuchEntityHandler(Consumer<NoSuchEntityException>) - Static method in class net.wildfyre.api.Internal

Registers a handler for the case where an Entity that was queried for update does not exist.

setText(String) - Method in class net.wildfyre.posts.Draft

setToken(String) - Static method in class net.wildfyre.api.Internal

Sets the token used by the API.

setUsername(String) - Method in class net.wildfyre.users.LoggedUser

Sets this user's name.

size() - Method in class net.wildfyre.utils.LazyMap

submit(Runnable) - Static method in class net.wildfyre.api.Internal

Submits a new task to be executed concurrently.

submitUpdate(D) - Static method in class net.wildfyre.api.Internal

Submits a new task to be executed concurrently, that updates a Descriptor.

subscribe() - Method in class net.wildfyre.posts.Draft

T

text() - Method in class net.wildfyre.posts.Comment

The text of this comment.

throwCantConnect(Request.CantConnectException) - Static method in class net.wildfyre.api.Internal

Call this method if you need to tell the client of this API that the server is unreachable at the moment, if you are in a concurrent context.

token() - Static method in class net.wildfyre.api.Internal

Returns the token used for authentication.

toString() - Method in class net.wildfyre.posts.Comment

toString() - Method in class net.wildfyre.users.User

U

unsubscribe() - Method in class net.wildfyre.posts.Draft

update() - Method in class net.wildfyre.descriptors.Descriptor

Updates this Descriptor.

update() - Method in class net.wildfyre.posts.Draft

update() - Method in class net.wildfyre.posts.Post

update() - Method in class net.wildfyre.users.User

use() - Method in class net.wildfyre.descriptors.Descriptor

Marks this descriptors' last usage as now.

User - Class in net.wildfyre.users

Users - Class in net.wildfyre.users

V

valueOf(String) - Static method in enum net.wildfyre.http.DataType

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.wildfyre.http.DataType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Method in class net.wildfyre.utils.LazyMap

W

WildFyre - Class in net.wildfyre.api

The primary means of interaction with the API.

WildFyre() - Constructor for class net.wildfyre.api.WildFyre

A B C D E G H I K L M N O P R S T U V W