Area (wflib-java 0.6.1-g24f8de8 API)

java.lang.Object
- net.wildfyre.descriptors.Descriptor
- - net.wildfyre.areas.Area

```
public class Area
extends Descriptor
```
This class represents an Area.
Areas are a way Posts are 'grouped'.

Each user's spread and reputation is different from one Area to another. The reputation goes up and down when you do certain actions. The spread determines how many people can see your Posts, it cannot be lower than 4.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cachedDraft(Draft draft)` Adds a Draft to the cache.
`Optional<Post>`	`cachedPost(long id)` Gets the post with the given ID from the cache.
`CacheManager`	`cacheManager()` The Cache Manager that handles this object.
`Draft`	`draft()` Creates a new Draft, that will later be converted to a Post.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`ID()` The ID of this Area, which looks like its name in all lowercase characters.
`void`	`loadDrafts()` Clears the Draft Cache and loads it again.
`void`	`loadOwnPosts()` Queries the server for the list of posts that are owned by the logged-in user.
`String`	`name()` The display name of the Area.
`Stream<Post>`	`ownPosts()` The posts owned by this user.
`List<Post>`	`ownPostsList()` The posts owned by this user.
`Optional<Post>`	`post(long id)` Gets the post with the given ID from the cache, or from the server.
`void`	`removeCached(Draft draft)` Removes a Draft from the cache.
`OptionalInt`	`reputation()` The reputation of the logged-in user, in the current area.
`OptionalInt`	`spread()` The spread of the logged-in user, in the current area.
`String`	`toString()`
`void`	`update()` Updates this Descriptor.

Methods inherited from class net.wildfyre.descriptors.Descriptor
isNew, isValid, isValid, use

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - ID
```
public String ID()
```
    The ID of this Area, which looks like its name in all lowercase characters.
    This API is written so you never *need* to use IDs; so if you are not sure why this exists, you can safely ignore it.
    
    Returns:
    
    The ID of this Area.
  - name
```
public String name()
```
    The display name of the Area.
    In future versions, the display name of the Area will be handled by the server. This has not been implemented yet, in the meantime, we provide a method that takes the ID and adds an uppercase letter to the beginning of each word. Since this method is temporary, we make no claim that it is performance-efficient.
    
    Returns:
    
    The display name of the Area.
  - reputation
```
public OptionalInt reputation()
```
    The reputation of the logged-in user, in the current area.
    The reputation increases and decreases depending on your overall actions on WildFyre. You cannot control it.
    
    Returns:
    
    Your reputation.
    
    See Also:
    
    Spread
  - spread
```
public OptionalInt spread()
```
    The spread of the logged-in user, in the current area.
    Your spread is related to your reputation, but cannot be inferior to 4. You cannot control it.
    
    Returns:
    
    Your spread.
    
    See Also:
    
    Reputation
  - cacheManager
```
public CacheManager cacheManager()
```
    Description copied from class: Descriptor
    
    The Cache Manager that handles this object.
    
    Specified by:
    
    cacheManager in class Descriptor
    
    Returns:
    
    This object.
  - update
```
public void update()
            throws Request.CantConnectException,
                   NoSuchEntityException
```
    Description copied from class: Descriptor
    
    Updates this Descriptor.
    The update is always executed in the current thread.
    
    Specified by:
    
    update in class Descriptor
    
    Throws:
    
    Request.CantConnectException
    
    NoSuchEntityException
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - post
```
public Optional<Post> post(long id)
```
    Gets the post with the given ID from the cache, or from the server.
    If the post is cached, this method will return in constant time and launch an update job in a new thread if needed; if the post is not cached, this method will request it from the server in the current thread and only return after parsing the result.
    
    Parameters:
    
    id - the ID of the post
    
    Returns:
    
    The post that corresponds to the given ID, or an empty optional if no such post exist.
  - cachedPost
```
public Optional<Post> cachedPost(long id)
```
    Gets the post with the given ID from the cache. This method will not attempt any call to the API, and therefore executes in constant time.
    
    Parameters:
    
    id - the ID of the post
    
    Returns:
    
    The post that corresponds to the given ID, or an empty optional if that ID is not in the cache.
  - loadDrafts
```
public void loadDrafts()
                throws Request.CantConnectException
```
    Clears the Draft Cache and loads it again. Any unsaved Draft will be lost.
    
    Throws:
    
    Request.CantConnectException - if the API cannot connect to the server.
  - cachedDraft
```
public void cachedDraft(Draft draft)
```
    Adds a Draft to the cache.
    Note that this method does not save the Draft server-side. If this is what you want to do, see draft().
    
    Parameters:
    
    draft - the Draft
  - removeCached
```
public void removeCached(Draft draft)
```
    Removes a Draft from the cache.
    Note that this method does not delete the Draft from the server's data. If this is what you want to do, see Draft.delete().
    
    Parameters:
    
    draft - the draft that should be removed from the cache.
    
    See Also:
    
    More details
  - draft
```
public Draft draft()
```
    Creates a new Draft, that will later be converted to a Post.
    This method is a wrapper around Draft.Draft(String) to enable cleaner code without touching to IDs.
    
    Returns:
    
    A new Draft.
  - loadOwnPosts
```
public void loadOwnPosts()
                  throws Request.CantConnectException
```
    Queries the server for the list of posts that are owned by the logged-in user. Note that the posts themselves aren't loaded, only their ID. This method will save the list internally, but not return it.
    
    Throws:
    
    Request.CantConnectException - if the lib cannot reach the server
    
    See Also:
    
    The list of posts owned by the logged-in user, as a Stream, The list of posts owned by the logged-in user, as a List
  - ownPostsList
```
public List<Post> ownPostsList()
```
    The posts owned by this user.
    Note that you need to load them first, using loadOwnPosts(), otherwise, this method will return an empty list.
    
    This method internally translates the stored list of IDs to a list of posts. During this process, posts are queried using post(long); see its documentation for more information about the use of threads.
    
    Returns:
    
    The list of posts owned by this user.
    
    See Also:
    
    This method as a Stream, for better performances.
  - ownPosts
```
public Stream<Post> ownPosts()
```
    The posts owned by this user.
    Note that you need to load them first, using loadOwnPosts()<, otherwise, this method will return an empty Stream./p>
    This method internally translates the stored list of IDs to a list of posts. During this process, posts are queried using post(long); see its documentation for more information about the use of threads.
    
    Returns:
    
    A Stream of the posts the user owns.
    
    See Also:
    
    This method as a List, for compatibility with the "traditionnal way".

Class Area

Method Summary

Methods inherited from class net.wildfyre.descriptors.Descriptor

Methods inherited from class java.lang.Object

Method Detail

ID

name

reputation

spread

cacheManager

update

equals

hashCode

toString

post

cachedPost

loadDrafts

cachedDraft

removeCached

draft

loadOwnPosts

ownPostsList

ownPosts