net.wildfyre.areas

Class Areas

java.lang.Object

net.wildfyre.areas.Areas

public class Areas
extends Object

This class is a singleton that represents the available areas.

See Also:

Implementation details

Method Summary

Modifier and Type	Method and Description
static CacheManager	cacheManager() The cache manager that is responsible for all Areas.
static void	clean() Removes the areas that are not valid anymore.
static void	clear() Removes the loaded areas.
static Collection<Area>	collection() Gets the list of areas.
static Optional<Area>	get(String areaID) Gets the Area that has the given String as an ID.
static void	init() Initializes Areas by calling load(), Area.loadDrafts() and Area.loadOwnPosts().
static void	load() Loads the list of areas.
static Stream<Area>	stream() Gets a sequential stream over the areas.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

init

public static void init()
                 throws Request.CantConnectException

Initializes Areas by calling load(), Area.loadDrafts() and Area.loadOwnPosts().

Throws:

Request.CantConnectException - if the server cannot connect to the API.

load

public static void load()
                 throws Request.CantConnectException

Loads the list of areas.

This method is executed in the current thread.

Throws:

Request.CantConnectException - if the API cannot connect to the server

get

public static Optional<Area> get(String areaID)

Gets the Area that has the given String as an ID.

This method is written to use IDs. This API is crafted so you never need IDs, so you probably don't need this method.

Parameters:

areaID - the ID of the requested area.

Returns:

The Area corresponding to the given ID, or an empty optional.

collection

public static Collection<Area> collection()

Gets the list of areas.

The returned collection is read-only, and cannot be modified in any way.

Returns:

The list of areas.

See Also:

Idem as a Stream, less object instantiation

stream

public static Stream<Area> stream()

Gets a sequential stream over the areas.

Returns:

A stream over the areas.

See Also:

Idem as a Collection

clear

public static void clear()

Removes the loaded areas.

cacheManager

public static CacheManager cacheManager()

The cache manager that is responsible for all Areas.

Returns:

The Area Cache Manager.

clean

public static void clean()

Removes the areas that are not valid anymore.

See Also:

Modify the Cache Manager.